de13a7319b
Done with the commands below. The following crates have had various changes, and should get a patchlevel bump. Since they are pre-1.0, we do not need to distinguish new APIs from other changes. ``` cargo set-version --bump patch -p arti-client cargo set-version --bump patch -p safelog cargo set-version --bump patch -p tor-bytes cargo set-version --bump patch -p tor-cert cargo set-version --bump patch -p tor-circmgr cargo set-version --bump patch -p tor-config cargo set-version --bump patch -p tor-consdiff cargo set-version --bump patch -p tor-dirclient cargo set-version --bump patch -p tor-dirmgr cargo set-version --bump patch -p tor-error cargo set-version --bump patch -p tor-hsservice cargo set-version --bump patch -p tor-linkspec cargo set-version --bump patch -p tor-llcrypto cargo set-version --bump patch -p tor-netdir cargo set-version --bump patch -p tor-netdoc cargo set-version --bump patch -p tor-proto cargo set-version --bump patch -p tor-rpcbase cargo set-version --bump patch -p tor-socksproto ``` This crate has new features, but no new non-experimental Rust APIs. So even though it is post-1.0, it gets a patchlevel bump. ``` cargo set-version --bump patch -p arti ``` |
||
---|---|---|
.. | ||
src | ||
testdata | ||
Cargo.toml | ||
README.md |
README.md
tor-dirmgr
Code to fetch, store, and update Tor directory information.
Overview
This crate is part of Arti, a project to implement Tor in Rust.
In its current design, Tor requires a set of up-to-date authenticated directory documents in order to build multi-hop anonymized circuits through the network.
This directory manager crate is responsible for figuring out which directory information we lack, downloading what we're missing, and keeping a cache of it on disk.
Compile-time features
-
mmap
(default) -- Use memory mapping to reduce the memory load for reading large directory objects from disk. -
routerdesc
-- (Incomplete) support for downloading and storing router descriptors. -
compression
(default) -- Build support for downloading compressed documents. Requires a C compiler. -
bridge-client
: Provide APIs used to fetch and use bridge information. -
full
-- Enable all features above.
Non-additive features
static
-- Try to link with a static copy of sqlite3.
Experimental and unstable features
Note that the APIs enabled by these features are NOT covered by semantic versioning1 guarantees: we might break them or remove them between patch versions.
-
experimental-api
: Add additional non-stable APIs to our public interfaces. -
dirfilter
: enable an experimental mechanism to modify incoming directory information before it is used. -
experimental
: Enable all the above experimental features.
License: MIT OR Apache-2.0
-
Remember, semantic versioning is what makes various
cargo
features work reliably. To be explicit: if you wantcargo update
to only make safe changes, then you cannot enable these features. ↩︎