mirrors/arti.git/crates/tor-circmgr/src/usage.rs, branch arti-v0.0.1mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v0.0.12021-10-29T13:06:06ZImprove docs of more (potentially re-exported) arti-client types2021-10-29T13:06:06Zetator@eta.st2021-10-29T13:06:06Zurn:sha1:a12fffc66accb0126500280f540b09c0922c1145
Most of the structs in `arti-client` have example code now, to give a
clearer idea of how they're used.
Annoyingly, a lot of the types exposed in `arti-client` are actually
re-exports, which makes documentation a bit harder: example code that
references other parts of `arti-client` can't actually be run as a
doctest, since the crate it's in is a dependency of `arti-client`.
We might be able to fix this in future by doing the documentation in
`arti-client` itself, but rustdoc seems to have some weird behaviours
there that need to be investigated first (for example, it seems to merge
the re-export and original documentation, and also put the re-export
documentation on the `impl` block for some reason).
For now, though, this commit just writes the docs from the point of view
of an `arti-client` consumer, removing notes specific to the crate in
which they're defined. It's not ideal, but at least the end user
experience is decent.
Turn StreamIsolation into a separate type.2021-10-25T16:32:18ZNick Mathewsonnickm@torproject.org2021-10-25T16:32:18Zurn:sha1:47234655ced86b8764ca8f31e5ef267f589f939b
Now that we have two kinds of isolation tokens (those set on a
stream, and those set by the stream's associated TorClient), we
need a more sophisticated kind of isolation.
This fixes the bug introduced with the previous commit, where
per-stream tokens would override per-TorClient tokens.
Replace references to arti-client in the documentation.2021-10-21T18:22:21ZNick Mathewsonnickm@torproject.org2021-10-21T18:19:34Zurn:sha1:730be38867c82b8d5ca76a569e1b1175ddf75cd4Implement guards for multihop paths.2021-10-13T14:27:46ZNick Mathewsonnickm@torproject.org2021-10-13T13:43:26Zurn:sha1:733aa3a4e2b03643094b48b5734ab89ef774b264
There are some limitations here, as noted in the comments.
Actually select guards for directory circuits.2021-10-13T13:30:50ZNick Mathewsonnickm@torproject.org2021-10-13T13:30:50Zurn:sha1:fd893f750cea0fedb082988e7fb5ee11a7efa479Pass the guard manager down to the path selection functions.2021-10-11T19:59:45ZNick Mathewsonnickm@torproject.org2021-10-11T19:59:45Zurn:sha1:5b06b3c64a11b5885f59089c221688a38bd3e4f3WIP2021-10-11T19:37:59ZNick Mathewsonnickm@torproject.org2021-10-11T19:37:59Zurn:sha1:ad851c43c64d50b072bbd8bd5f2b959938b09cddIntegrate GuardUsability and GuardMonitor into CircuitBuilder.2021-10-10T17:48:58ZNick Mathewsonnickm@torproject.org2021-10-10T17:34:38Zurn:sha1:34b576a8158114eb715616f85155d4b11513b78d
(When we're building a path with a guard, we need to tell the guard
manager whether the path succeeded, and we need to wait to hear
whether the guard is usable.)
Re-export configuration types from tor-client.2021-10-09T21:30:06ZNick Mathewsonnickm@torproject.org2021-10-09T21:21:45Zurn:sha1:58355d7d54acaa1057c0a375affdf766d54a0c37fix/silence clippy lints in test modules2021-09-08T15:28:31ZDaniel Eadesdanieleades@hotmail.com2021-08-30T07:52:16Zurn:sha1:fb3b8b84b5709ebe8a29051c43b82c4eef85decc