mirrors/arti.git/crates/arti-client/examples/readme.rs, branch arti-v1.0.0mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v1.0.02022-06-24T13:23:38Zclippy: 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
Allow creating unbootstrapped `TorClient`s (and `DirMgr`s)2022-02-11T16:42:19Zetator@eta.st2022-02-09T16:27:34Zurn:sha1:882e75cd280ede6dc284f11db9e8f17947435ebe
This commit changes how the `TorClient` type works, enabling it to be
constructed synchronously without initiating the bootstrapping process.
Daemon tasks are still started on construction (although some of them
won't do anything if the client isn't bootstrapped).
The old bootstrap() methods are now reimplemented in terms of the new
create_unbootstrapped() and bootstrap_existing() methods.
This required refactoring how the `DirMgr` works to enable the same sort
of thing there.
closes #293
Make current/create functions into runtime member functions.2022-01-26T19:06:58ZNick Mathewsonnickm@torproject.org2022-01-26T13:40:35Zurn:sha1:6f29d485e460b30cba992bcb407bf3c7e2a479b7
This should help avoid some amount of temptation towards API
proliferation.
Use *_with_prefs() for Option<ConnectPrefs> callers in TorClient::connect2022-01-08T21:36:49ZNeel Chauhanneel@neelc.org2022-01-08T21:36:42Zurn:sha1:439b8b3e64f6f4cb5a032ee3ceafb4675003f259Merge branch 'readme_fixes'2021-11-30T14:12:51ZNick Mathewsonnickm@torproject.org2021-11-30T14:12:51Zurn:sha1:3b072c542064002f71d2a6a6a9fc22a83dbe5962Example needs to be the same as the readme2021-11-30T14:09:42Zdagondagon12@tutanota.com2021-11-29T14:29:37Zurn:sha1:0162ea82101be4eb6af5ae5bca20d86313b1f079MR review feedback2021-11-30T14:09:42Zdagondagon12@tutanota.com2021-11-29T14:15:15Zurn:sha1:bd1c37fe8ad6195dfe83c8caba47305e581df901Change sane_defaults() and with_directories()2021-11-29T19:20:34ZNick Mathewsonnickm@torproject.org2021-11-29T19:20:34Zurn:sha1:f107794b742fb075c673249999362afd28d77772
The sane_defaults() call is now the same as you get from a default
builder: by convention, we just call that method Default::default().
The with_directories() constructor makes more sense as a constructor
for the TorClientConfigBuilder than for TorClientConfig.