mirrors/arti.git/crates/arti-client/examples/lazy-init.rs, branch arti-v1.1.2mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v1.1.22023-01-27T13:28:02ZAllow clippy::unchecked_duration_subtraction in tests2023-01-27T13:28:02ZNick Mathewsonnickm@torproject.org2023-01-27T13:01:45Zurn:sha1:a6dd92843edf2bd4c58de62a0d562921e4191ada
This panics on error, and we're fine with a panic on misbehavior in
tests.
Allow "clippy::single_char_pattern" in tests.2022-10-12T12:50:29ZIan Jacksonijackson@chiark.greenend.org.uk2022-10-11T13:00:07Zurn:sha1:82ad9eea5f80331d0e26a7d5ccfeed9e58a615fb
This lint exists for perf reasons, and this is rarely relevant in
tests.
Using double quoted str is generally cognitively less burdensome.
clippy: Consolidate many lints in maint/add_warning2022-06-24T13:23:38ZIan Jacksonijackson@chiark.greenend.org.uk2022-06-24T12:24:00Zurn:sha1:23c352b96bf07c981bb396fa34ce83e512ada0b2
Found these by disabling the nightly dbg macro special case. Now, we
have a mechanism for globally adding suppressions to tests, we can use
that instead.
clippy: Add standard test lint block to several examples2022-06-24T13:23:38ZIan Jacksonijackson@chiark.greenend.org.uk2022-06-24T12:17:02Zurn:sha1:d965dc3f709259fbe1f0f954dcae50ccd4201799arti-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
Make a TorClientBuilder API.2022-02-18T20:28:31ZNick Mathewsonnickm@torproject.org2022-02-18T20:28:31Zurn:sha1:c910226b551a9ffc453e7f4baba0562d3a6d7bdc
This is a defensive API choice to protect against the possibility
that we'll want to add a bunch of other non-config options in
the future.
Closes #350
arti-client: add ability to automatically bootstrap2022-02-16T19:29:16Zetator@eta.st2022-02-16T15:57:24Zurn:sha1:790ea4af4bf5223ca81218d0f5508db2bd2db471
The new `BootstrapBehavior` enum controls whether an unbootstrapped
`TorClient` will bootstrap itself automatically (`Ondemand`) when an
attempt is made to use it, or whether the user must perform
bootstrapping themselves (`Manual`).
The `lazy-init` example shows how you could write a simple
`get_tor_client()` function that used a global `OnceCell` to share
a Tor client across an entire application with this API.
closes arti#278