mirrors/arti.git/crates/arti-client/src/lib.rs, branch arti-v0.0.4mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v0.0.42022-01-26T19:58:28ZFix documentation references for tor-rtcompat refactoring.2022-01-26T19:58:28ZNick Mathewsonnickm@torproject.org2022-01-26T19:58:28Zurn:sha1:5dcc821146542ebe7e794c306365be4117df86c2Make 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.
StreamPrefs: rename from ConnectPrefs2022-01-21T11:07:15ZIan Jacksonijackson@chiark.greenend.org.uk2022-01-20T18:05:10Zurn:sha1:aa4d8de16e99de41b384e77fb2fc265a4c750430
The docs even say this is about stream.
As @nickm writes in
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/252#note_2771289
we generally call end-to-end connections that are tunneled over Tor
"Streams" to distinguish them from everything else in the Tor
protocols that could possibly be called a "Connection".
That seems to apply here too.
Implement the basics of a bootstrap-status API.2022-01-13T15:29:49ZNick Mathewsonnickm@torproject.org2022-01-12T17:46:26Zurn:sha1:1bd2790d51cc43b4c08de746560fa17c548f57ce
The purpose of a this API is to tell the user how far along Arti is
in getting bootstrapped, and if it's stuck, what it's stuck on.
This API doesn't yet expose any useful information: by the time it's
observable to a client, it's always "100% bootstrapped." But I'm
putting it in a MR now so that we can review the basic idea, and to
avoid conflicts with later work on tickets like #293 and #278.
This is part of #96.
Improve the layout of crate exports; add runtime convenience functions2022-01-11T15:16:03Zetator@eta.st2022-01-11T15:16:03Zurn:sha1:41e202a3a4c582dedd2c9c5c5c60369b4a53fae0
This commit addresses multiple problems highlighted by arti#182:
- `arti-client` had some types in its public API that weren't accessible
without importing another crate (`CfgPath`, `DataReader`,
`DataWriter`). This has been fixed.
- In addition, the doc comments for `DataReader` and `DataWriter` were
cleaned up to be of better quality, now that they're public.
- It was impossible to use `arti-client` without also importing
`tor-rtcompat`. This is now fixed by the addition of two convenience
methods: `TorClient::bootstrap_with_tokio` and
`TorClient::bootstrap_with_async_std`.
- Potentially controversially: `tor-rtcompat` now returns *concrete*
types from methods like `current_runtime`, instead of `impl Runtime`.
- This was needed in order to actually be able to name the `TorClient`
type that results from using these methods.
- This does mean we lose API flexibility, but on balance I think this
is a good thing, because the API we *do* have is actually usable...
Make the arti_client::Result type public.2022-01-10T14:33:26ZNick Mathewsonnickm@torproject.org2022-01-10T14:33:26Zurn:sha1:7819dd7bace999fbffabec640ab7f47951a6d0d9
Closes #280.
Use *_with_prefs() for Option<ConnectPrefs> callers in TorClient::connect2022-01-08T21:36:49ZNeel Chauhanneel@neelc.org2022-01-08T21:36:42Zurn:sha1:439b8b3e64f6f4cb5a032ee3ceafb4675003f259extend lints to include 'clippy::all'2021-12-28T20:15:40ZDaniel Eadesdanieleades@hotmail.com2021-12-28T20:15:40Zurn:sha1:592642a9e6c1c03e525f8b452f4b97e6fd17ff9bChange 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.
add semicolons if nothing returned2021-11-25T13:20:37ZDaniel Eadesdanieleades@hotmail.com2021-11-25T13:14:05Zurn:sha1:db16d13df4779ac61005050dfe5ce05e3d5a1b5d