mirrors/arti.git/crates/tor-rtcompat/src/lib.rs, branch arti-v0.1.0mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v0.1.02022-03-01T13:16:02ZFix rustdoc errors.2022-03-01T13:16:02ZNick Mathewsonnickm@torproject.org2022-03-01T13:16:02Zurn:sha1:57a8fe5f55beaab09e2f9b4a50dc2092885b5017arti-client: use PreferredRuntime by default, doc cleanups2022-02-28T16:41:13Zetator@eta.st2022-02-25T18:13:02Zurn:sha1:13ba0ea005ddd87bba2d53ab738ce948f031e1e8
This makes using the `PreferredRuntime` the first-class option inside
`arti-client`, freeing users who don't want to think about runtimes from
having to do so.
`TorClient::create_unbootstrapped` and `builder` now automatically
use this runtime, leaving only `builder_custom` for users who wish to
manually specify a runtime.
This lets us clean up the docs a lot: mentions of using custom runtimes
are now relegated to nearer the end of the crate-level documentation,
and we mostly just link to `tor_rtcompat`'s docs to explain more there.
Instead, we take some more time to explain how you use the builder API
to create clients synchronously.
Other doc cleanups included getting rid of the explanation of `TorAddr`
in the main crate-level doc; this is already well-documented elsewhere,
and is something users should discover organically later.
fixes arti#326
tor-rtcompat: refactor PreferredRuntime, clean up docs2022-02-25T17:34:05Zetator@eta.st2022-02-25T17:34:05Zurn:sha1:387ebda740081983cf1f051c630a7729dc6e7926
`PreferredRuntime` is now an opaque wrapper struct that contains the
"actual" preferred runtime as a type alias. The `current_user_runtime`
and `create_runtime` functions become `PreferredRuntime::current` and
`PreferredRuntime::create`, respectively.
This removes the dependence on `impl Trait`, meaning we can now name the
returned runtime (yay!).
In addition, the documentation was cleaned up a bit to make it
(hopefully) flow better. Items that don't make sense to publicize, like
testing implementation details, have been marked #[doc(hidden)] and
semver warnings added.
add example of tcp hook2022-02-23T13:29:37Ztrinity-1686atrinity@deuxfleurs.fr2022-02-22T21:50:11Zurn:sha1:81d7747d7b53482f2960b925f7c21cc04dccc642
this required to make additional types public
Change deny(clippy::all) to warn(clippy::all).2022-02-14T14:24:06ZNick Mathewsonnickm@torproject.org2022-02-14T14:24:06Zurn:sha1:1cecc7e45a9a432f87a8f11abb8cb86b35464a0b
Closes #338.
tor-rtcompat: Add some miscellaneous tests2022-01-27T20:48:30ZNick Mathewsonnickm@torproject.org2022-01-27T20:48:30Zurn:sha1:f7373f8b2001d90a63ca08c799e9f47e8f94144d
These probably aren't for things that will fail IRL, but it's nice
to have coverage on the code, just in case.
tor-rtcompat: Simplify test-declaration macros.2022-01-27T20:09:09ZNick Mathewsonnickm@torproject.org2022-01-27T20:09:09Zurn:sha1:af8526225730df431a1b2d64e3a52713998a0816
Now there's much less copy-and-paste.
Move tor-rtcompat tests to lib.rs2022-01-27T19:45:00ZNick Mathewsonnickm@torproject.org2022-01-27T19:42:24Zurn:sha1:9435e4b36e33485b7b607686b2fb0248f3fa21d6
This makes our layout more similar to our other crates, and
successfully informs our grcov exclusion pattern that these tests
are indeed tests.
Doing this knocks down the reported coverage for the tor-rtcompat
crate, but that's okay: we hadn't earned it.
I hereby promise that this commit is only code-movement.
Document why {current,create}_runtime are type-erased2022-01-27T15:31:45ZNick Mathewsonnickm@torproject.org2022-01-27T15:31:45Zurn:sha1:9f3ad85d75ac7c5a1edf6be1be1008cd1015ee08Apply @eta's suggestions from review on !2632022-01-27T15:25:57Zetator@eta.st2022-01-27T15:25:57Zurn:sha1:c4321289f24c778f0451112cf4f4c9eac8b77fad
Comment-only.