arti/crates/tor-netdir
Nick Mathewson 98cda34fb8 netdir: Make pick() functions take FnMut closures.
There's no reason to enforce their being Fn closures, and allowing
them to be FnMut allows us to count which filters make us rejected
given relays.
2022-07-12 11:43:49 -04:00
..
src netdir: Make pick() functions take FnMut closures. 2022-07-12 11:43:49 -04:00
Cargo.toml Bump crate and dependency versions. 2022-06-24 12:00:22 -04:00
README.md
semver.md netdir: Make pick() functions take FnMut closures. 2022-07-12 11:43:49 -04:00

README.md

tor-netdir

Represents a clients'-eye view of the Tor network.

Overview

The tor-netdir crate wraps objects from tor-netdoc, and combines them to provide a unified view of the relays on the network. It is responsible for representing a client's knowledge of the network's state and who is on it.

This crate is part of Arti, a project to implement Tor in Rust. Its purpose is to expose an abstract view of a Tor network and the relays in it, so that higher-level crates don't need to know about the particular documents that describe the network and its properties.

There are two intended users for this crate. First, producers like [tor-dirmgr] create [NetDir] objects fill them with information from the Tor network directory. Later, consumers like [tor-circmgr] use [NetDir]s to select relays for random paths through the Tor network.

Limitations

Only modern consensus methods and microdescriptor consensuses are supported.

License: MIT OR Apache-2.0