mirror of https://gitlab.torproject.org/tpo/core/arti http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v0.0.3 2022-01-10T14:33:26Z 2022-01-10T14:33:26Z Nick Mathewson nickm@torproject.org 2022-01-10T14:33:26Z urn:sha1:7819dd7bace999fbffabec640ab7f47951a6d0d9 Closes #280. 2022-01-08T21:36:49Z Neel Chauhan neel@neelc.org 2022-01-08T21:36:42Z urn:sha1:439b8b3e64f6f4cb5a032ee3ceafb4675003f259 2021-12-28T20:15:40Z Daniel Eades danieleades@hotmail.com 2021-12-28T20:15:40Z urn:sha1:592642a9e6c1c03e525f8b452f4b97e6fd17ff9b 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-11-25T13:20:37Z Daniel Eades danieleades@hotmail.com 2021-11-25T13:14:05Z urn:sha1:db16d13df4779ac61005050dfe5ce05e3d5a1b5d 2021-11-24T23:23:12Z Nick Mathewson nickm@torproject.org 2021-11-24T23:23:12Z urn:sha1:3e7e599a22972135f9c113a9a1e0757d22653481 2021-10-29T13:06:06Z eta tor@eta.st 2021-10-29T13:06:06Z urn:sha1:a12fffc66accb0126500280f540b09c0922c1145 Most of the structs in `arti-client` have example code now, to give a clearer idea of how they're used. Annoyingly, a lot of the types exposed in `arti-client` are actually re-exports, which makes documentation a bit harder: example code that references other parts of `arti-client` can't actually be run as a doctest, since the crate it's in is a dependency of `arti-client`. We might be able to fix this in future by doing the documentation in `arti-client` itself, but rustdoc seems to have some weird behaviours there that need to be investigated first (for example, it seems to merge the re-export and original documentation, and also put the re-export documentation on the `impl` block for some reason). For now, though, this commit just writes the docs from the point of view of an `arti-client` consumer, removing notes specific to the crate in which they're defined. It's not ideal, but at least the end user experience is decent. 2021-10-29T00:20:23Z Nick Mathewson nickm@torproject.org 2021-10-29T00:18:04Z urn:sha1:bf3bfdf62de9a0d2500da30ad986d4d4bf31e9f5 I'm not 100% sure this is better, but it might help the user understand how Arti works a bit better. 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) 2021-10-27T15:13:46Z Nick Mathewson nickm@torproject.org 2021-10-27T15:13:46Z urn:sha1:134c04a67adebff719011b608dabfa6da60ed247