aboutsummaryrefslogtreecommitdiff
path: root/crates/arti-client/src
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'clippy-allow-arc-clone' into 'main'Nick Mathewson2022-03-011-1/+0
|\ | | | | | | | | Disable clippy::clone_on_ref_ptr See merge request tpo/core/arti!352
| * Disable clippy::clone_on_ref_ptrIan Jackson2022-02-241-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This lint is IMO inherently ill-conceived. I have looked for the reasons why this might be thought to be a good idea and there were basically two (and they are sort of contradictory): I. "Calling ‘.clone()` on an Rc, Arc, or Weak can obscure the fact that only the pointer is being cloned, not the underlying data." This is the wording from https://rust-lang.github.io/rust-clippy/v0.0.212/#clone_on_ref_ptr It is a bit terse; we are left to infer why it is a bad idea to obscure this fact. It seems to me that if it is bad to obscure some fact, that must be because the fact is a hazard. But why would it be a hazard to not copy the underlying data ? In other languages, faliing to copy the underlying data is a serious correctness hazard. There is a whose class of bugs where things were not copied, and then mutated and/or reused in multiple places in ways that were not what the programmer intended. In my experience, this is a very common bug when writing Python and Javascript. I'm told it's common in golang too. But in Rust this bug is much much harder to write. The data inside an Arc is immutable. To have this bug you'd have use interior mutability - ie mess around with Mutex or RefCell. That provides a good barrier to these kind of accidents. II. "The reason for writing Rc::clone and Arc::clone [is] to make it clear that only the pointer is being cloned, as opposed to the underlying data. The former is always fast, while the latter can be very expensive depending on what is being cloned." This is the reasoning found here https://github.com/rust-lang/rust-clippy/issues/2048 This is saying that *not* using Arc::clone is hazardous. Specifically, that a deep clone is a performance hazard. But for this argument, the lint is precisely backwards. It's linting the "good" case and asking for it to be written in a more explicit way; while the supposedly bad case can be written conveniently. Also, many objects (in our codebase, and in all the libraries we use) that are Clone are in fact simply handles. They contain Arc(s) (or similar) and are cheap to clone. Indeed, that is the usual case. It does not make sense to distinguish in the syntax we use to clone such a handle, whether the handle is a transparent Arc, or an opaque struct containing one or more other handles. Forcing Arc::clone to be written as such makes for code churn when a type is changed from Arc<Something> to Something: Clone, or vice versa.
* | Fix rustdoc errors.Nick Mathewson2022-03-011-8/+9
| |
* | Run rustfmt.Nick Mathewson2022-03-011-1/+0
| |
* | Merge remote-tracking branch 'origin/mr/371'Nick Mathewson2022-03-011-0/+9
|\ \
| * | arti-client: Add stability warning to config moduleIan Jackson2022-03-011-0/+9
| | |
* | | Merge branch '010_docs'Nick Mathewson2022-03-012-7/+20
|\| |
| * | Update our stability warning on arti-client.Nick Mathewson2022-02-281-5/+12
| | |
| * | Add warnings about configuration stability.Nick Mathewson2022-02-281-2/+8
| | |
* | | Merge branch 'main'Ian Jackson2022-03-011-2/+6
|\| | | | | | | | | | | | | | | | | | | | Fixed conflict in crates/arti-client/src/lib.rs as per tree from https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/364/#note_2782166 ie 13e55b8d7c22c26e55ba75823409b477f1bce66b
| * | Split "static" into sqlite and native-tls features.Nick Mathewson2022-02-251-4/+19
| | | | | | | | | | | | | | | | | | | | | Otherwise, it's impossible to get a static sqlite linkage without also getting native-tls, even if you wanted rustls. Closes #302.
* | | arti-client: use PreferredRuntime by default, doc cleanupseta2022-02-282-108/+117
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Merge branch 'get-runtime' into 'main'Ian Jackson2022-02-251-0/+11
|\ \ | | | | | | | | | | | | TorClient: Add get_runtime() convenience method See merge request tpo/core/arti!350
| * | TorClient:runtime(): rename from get_runtimeIan Jackson2022-02-251-1/+1
| | | | | | | | | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/350#note_2781368
| * | TorClient: Add get_runtime() convenience methodIan Jackson2022-02-241-0/+11
| | |
* | | arti-client: Unlock the state manager on failure to bootstrapeta2022-02-243-1/+38
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | `StateMgr` got a new `unlock()` method that does what it says on the tin. We now call it from `bootstrap()` using the new `util::StateMgrUnlockGuard`, which works in a manner similar to the `BoolResetter` from `tor_dirmgr`. (A decent small little task in future might be to unify these types in some sort of general arti utility crate?) closes arti#335
* | | Merge branch 'http-layer' into 'main'eta2022-02-241-0/+8
|\ \ \ | |_|/ |/| | | | | | | | Initial cut of hyper bindings as a library crate See merge request tpo/core/arti!342
| * | impl From<TorAddrError> for tor_error::ErrorIan Jackson2022-02-231-0/+8
| |/ | | | | | | | | It auto-converts to ErrorDetail but add this for convenience of callers which don't want to look into that unstable API.
* | Documentation suggestion from review.Ian Jackson2022-02-231-1/+1
| |
* | Make a TorClientBuilder API.Nick Mathewson2022-02-183-43/+108
|/ | | | | | | | 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
* Merge branch 'remaining-errors'Nick Mathewson2022-02-171-2/+11
|\
| * Rename ExitTimeout to RemoteNetworkTimeout.Nick Mathewson2022-02-171-1/+1
| |
| * arti_client: provide Kinds for all errors.Nick Mathewson2022-02-161-1/+10
| |
* | Merge branch 'eta/lazy-init' into 'main'eta2022-02-162-14/+76
|\ \ | |/ |/| | | | | | | | | arti-client: add ability to automatically bootstrap Closes #278 See merge request tpo/core/arti!322
| * arti-client: add ability to automatically bootstrapeta2022-02-162-14/+76
| | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Move persistent state flush from client to circmgrYuan Lyu2022-02-151-14/+0
|/
* Merge branch 'explain_into_tor_addr' into 'main'Nick Mathewson2022-02-141-4/+25
|\ | | | | | | | | | | | | More docs for IntoTorAddr Closes #253 See merge request tpo/core/arti!305
| * More docs for IntoTorAddrNick Mathewson2022-02-141-4/+25
| |
* | Merge branch 'ticket_337' into 'main'eta2022-02-141-37/+11
|\ \ | | | | | | | | | | | | | | | | | | Simplify wait_for_bootstrap to use a Mutex. Closes #337 See merge request tpo/core/arti!308
| * | Simplify wait_for_bootstrap to use a Mutex.Nick Mathewson2022-02-141-37/+11
| |/ | | | | | | | | | | | | | | Since the only purpose of this function is to make sure that no bootstrapping task is running, a simple futures::lock::Mutex should do the job just fine. Closes #337.
* / Change deny(clippy::all) to warn(clippy::all).Nick Mathewson2022-02-141-1/+1
|/ | | | Closes #338.
* Rename bootstrap_existing to bootstrap.Nick Mathewson2022-02-112-12/+10
| | | | (Looks like this one got missed.)
* Merge branch 'eta/unbootstrapped-clients' into 'main'Nick Mathewson2022-02-113-65/+215
|\ | | | | | | | | | | | | Allow creating unbootstrapped `TorClient`s (and `DirMgr`s) Closes #293 See merge request tpo/core/arti!298
| * Allow creating unbootstrapped `TorClient`s (and `DirMgr`s)eta2022-02-113-65/+215
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Write some examples for TorClient::connect()Nick Mathewson2022-02-111-5/+64
|/ | | | | | These should explain better what you can pass as an address, and what you should do if you _really need_ to provide a SocketAddr or something.
* Update launch of chan expiration task to new APINick Mathewson2022-02-081-4/+6
| | | | This fixes a compilation error.
* ErrorDetail Simplify visibility macros a bit.Nick Mathewson2022-02-082-19/+53
| | | | | | | | Instead of declaring a macro that takes vis as an argument, we now conditionally declare a macro that applies an appropriate visibility. There's a long comment explaining the rationale here, along with a couple of other solutions that don't work.
* Rename TorResult to Result.Nick Mathewson2022-02-083-27/+28
| | | | | | | This is closer to common usage. (Not that we all agree with common usage, but it's closer to what people expect.)
* arti_client: Rename Error to ErrorDetail.Nick Mathewson2022-02-084-48/+43
| | | | | | | This is closer to what we described in Errors.md. Also, remove the (sometimes private) Result alias: it was only used in one or two places, and never exposed in public.
* TorError: Make detail() an accessor function.Nick Mathewson2022-02-081-4/+25
| | | | | | This change lets us make TorError's members unconditionally hidden, and makes our API a little more consistent (since basically nothing else is a public field).
* Merge branch 'error-improvements' into 'main'eta2022-02-083-147/+225
|\ | | | | | | | | Hopefully uncontroversial improvements to new Error code See merge request tpo/core/arti!291
| * Docs and clarification for a bunch of Error stuffNick Mathewson2022-02-042-64/+102
| |
| * Make SpawnError wrappers contain a 'spawning' stringNick Mathewson2022-02-042-36/+56
| | | | | | | | | | (By our convention, these errors should say what we were trying to spawn when the error occurred.)
| * Make the Error detail type non-exported from arti-clientNick Mathewson2022-02-043-41/+44
| | | | | | | | | | | | | | | | | | | | | | At least by default, we should have Error be private, and not expose it as part of our APIs. To keep functionality in `arti`, I had to add an `ExitTimeout` error kind. For interface consistency, I also re-exported ErrorKind and HasError from `arti_client`.
| * Test that TorError implements the right traits.Nick Mathewson2022-02-041-3/+21
| | | | | | | | | | I had planned to use assert_impl, but that can't check for the 'static lifetime.
| * Make TorError implement Clone.Nick Mathewson2022-02-041-3/+2
| | | | | | | | | | This patch makes only minimal changes in lower-level error types: we have more refactoring to do.
* | Expire channels that have been unused for too longYuan Lyu2022-02-041-0/+23
|/
* errors: Add some TODOs as per discussion commentsIan Jackson2022-02-041-0/+3
|
* errors: Drop "Error" and "Failed" from various enum variantsIan Jackson2022-02-042-3/+3
|
* Box the Error in a TorErrorIan Jackson2022-02-041-2/+10
| | | | | | This will get quite large and boxing it here is very convenient. This also avoids us exposing a large error type to our callers.
generated by cgit v1.2.3 (git 2.46.0) at 2026-08-26 20:16:27 +0000