History

Ian Jackson c5f6b2e3a5 tor-error: Add missing footnote I C&P this from tor-dirmgr, and missed this part.		2023-03-31 18:45:40 +01:00
..
src	tor-error: Add OnionServiceNotRunning error	2023-03-31 18:01:36 +01:00
Cargo.toml	tor-error: Put OnionService errors behind a new experimental-api feature	2023-03-31 17:57:24 +01:00
README.md	tor-error: Add missing footnote	2023-03-31 18:45:40 +01:00

README.md

tor-error

Support for error handling in Tor and Arti

Primarily, this crate provides the [ErrorKind] enum, and associated [HasKind] trait.

There is also some other miscellany, supporting error handling in crates higher up the dependency stack.

Features

backtrace -- Enable backtraces in internal errors. (On by default.)

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.

experimental-api: Add additional non-stable APIs to our public interfaces.

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. ↩︎