mirrors/arti.git/crates/tor-rtcompat/src, branch arti-v0.1.0

Fix rustdoc errors.

2022-03-01T13:16:02Z

arti-client: use PreferredRuntime by default, doc cleanups

2022-02-28T16:41:13Z

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 docs

2022-02-25T17:34:05Z

`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.

Merge branch 'tls-trait' into 'main'

2022-02-25T11:13:34Z

tor-rtcompat: Provide TLS wrapping for all streams See merge request tpo/core/arti!349

Fix rustdoc "skip this" markup

2022-02-24T16:19:28Z

tor-rtcompat: Provide TLS wrapping for all streams

2022-02-24T14:26:38Z

Now all of the runtime types we provide all impl ~~TlsProvider ~~where S: ... rather than merely TlsProvider. And we document and intent to perhaps require this in the future.~~~~

add example of tcp hook

2022-02-23T13:29:37Z
this required to make additional types public

Change deny(clippy::all) to warn(clippy::all).

2022-02-14T14:24:06Z
Closes #338.

tor-rtcompat: remove some unused code.

2022-01-27T20:52:59Z
Nothing actually used these accessor functions, and it's not clear what would. We can add them later if they're needed.

tor-rtcompat: Add some miscellaneous tests

2022-01-27T20:48:30Z
These probably aren't for things that will fail IRL, but it's nice to have coverage on the code, just in case.