mirror of https://gitlab.torproject.org/tpo/core/arti http://git.dilluti0n.com/mirrors/arti.git/atom?h=derive-traits 2022-02-28T16:41:13Z 2022-02-28T16:41:13Z eta tor@eta.st 2022-02-25T18:13:02Z urn: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 2022-02-11T16:42:19Z eta tor@eta.st 2022-02-09T16:27:34Z urn: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 2022-01-26T19:06:58Z Nick Mathewson nickm@torproject.org 2022-01-26T13:40:35Z urn:sha1:6f29d485e460b30cba992bcb407bf3c7e2a479b7 This should help avoid some amount of temptation towards API proliferation. 2022-01-08T21:36:49Z Neel Chauhan neel@neelc.org 2022-01-08T21:36:42Z urn:sha1:439b8b3e64f6f4cb5a032ee3ceafb4675003f259 2021-11-30T14:12:51Z Nick Mathewson nickm@torproject.org 2021-11-30T14:12:51Z urn:sha1:3b072c542064002f71d2a6a6a9fc22a83dbe5962 2021-11-30T14:09:42Z dagon dagon12@tutanota.com 2021-11-29T14:29:37Z urn:sha1:0162ea82101be4eb6af5ae5bca20d86313b1f079 2021-11-30T14:09:42Z dagon dagon12@tutanota.com 2021-11-29T14:15:15Z urn:sha1:bd1c37fe8ad6195dfe83c8caba47305e581df901 2021-11-29T19:20:34Z Nick Mathewson nickm@torproject.org 2021-11-29T19:20:34Z urn: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. 2021-10-28T18:20:42Z eta tor@eta.st 2021-10-28T17:32:49Z urn:sha1:dcdd8c59dfa6afd3ee903d5eacab4a99c1258e7d This overhauls the top-level `arti-client` documentation significantly: - the "Using arti-client" section walks the user through all of the necessary steps to initiate a Torified TCP connection, and then provides a code example - this example is also available as `examples/readme.rs`; it's not run as a doctest, since it involves connecting to Tor - a "More advanced usage" subheading provides information about stream isolation (and can potentially be used for other interesting features once we get them). - a new "Multiple runtime support" section was added to explain the purpose and usage of the `tor-rtcompat` crate - the section on design and privacy considerations was removed; this is probably okay to keep in a README, but users of the crate aren't going to be interested in this (at least I don't think) (also, the doc comment for `arti_client::Error` was fixed to make actual sense)