History

Nick Mathewson 388e0cbab5 Bump crates that have had backward compatible API changes.		2022-10-03 09:52:34 -04:00
..
src	Mark all bridge and pt features as experimental for now.	2022-09-29 10:59:19 -04:00
Cargo.toml	Bump crates that have had backward compatible API changes.	2022-10-03 09:52:34 -04:00
README.md	Update README.md files.	2022-09-30 15:19:48 -04:00
semver.md	ChanMgr: new (unimplemented) APIs for pluggable transports	2022-09-23 14:08:24 -04:00

README.md

tor-chanmgr

tor-chanmgr: Manage a set of channels on the Tor network.

Overview

This crate is part of Arti, a project to implement Tor in Rust.

In Tor, a channel is a connection to a Tor relay. It can be direct via TLS, or indirect via TLS over a pluggable transport. (For now, only direct channels are supported.)

Since a channel can be used for more than one circuit, it's important to reuse channels when possible. This crate implements a [ChanMgr] type that can be used to create channels on demand, and return existing channels when they already exist.

Compile-time features

Experimental and unstable features

Note that the APIs enabled by these features are NOT covered by semantic versioning¹ guarantees: we might break them or remove them between patch versions.

pt-client -- Build with (as yet unimplemented) APIs to support pluggable transports.
experimental -- Build with all experimental features above.

License: MIT OR Apache-2.0

Remember, semantic versioning is what makes various cargo features work reliably. To be explicit: if you want cargo update to only make safe changes, then you cannot enable these features. ↩︎