summaryrefslogtreecommitdiff
path: root/crates/tor-rtcompat/src/lib.rs
Commit message (Collapse)AuthorAgeFilesLines
* Fix rustdoc errors.Nick Mathewson2022-03-011-1/+1
|
* arti-client: use PreferredRuntime by default, doc cleanupseta2022-02-281-6/+18
| | | | | | | | | | | | | | | | | | | | | | 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
* tor-rtcompat: refactor PreferredRuntime, clean up docseta2022-02-251-55/+122
| | | | | | | | | | | | | | | `PreferredRuntime` is now an opaque wrapper struct that contains the "actual" preferred runtime as a type alias. The `current_user_runtime` and `create_runtime` functions become `PreferredRuntime::current` and `PreferredRuntime::create`, respectively. This removes the dependence on `impl Trait`, meaning we can now name the returned runtime (yay!). In addition, the documentation was cleaned up a bit to make it (hopefully) flow better. Items that don't make sense to publicize, like testing implementation details, have been marked #[doc(hidden)] and semver warnings added.
* add example of tcp hooktrinity-1686a2022-02-231-0/+5
| | | | this required to make additional types public
* Change deny(clippy::all) to warn(clippy::all).Nick Mathewson2022-02-141-1/+1
| | | | Closes #338.
* tor-rtcompat: Add some miscellaneous testsNick Mathewson2022-01-271-0/+6
| | | | | These probably aren't for things that will fail IRL, but it's nice to have coverage on the code, just in case.
* tor-rtcompat: Simplify test-declaration macros.Nick Mathewson2022-01-271-60/+35
| | | | Now there's much less copy-and-paste.
* Move tor-rtcompat tests to lib.rsNick Mathewson2022-01-271-7/+312
| | | | | | | | | | | This makes our layout more similar to our other crates, and successfully informs our grcov exclusion pattern that these tests are indeed tests. Doing this knocks down the reported coverage for the tor-rtcompat crate, but that's okay: we hadn't earned it. I hereby promise that this commit is only code-movement.
* Document why {current,create}_runtime are type-erasedNick Mathewson2022-01-271-9/+19
|
* Apply @eta's suggestions from review on !263eta2022-01-271-1/+1
| | | Comment-only.
* Fix documentation references for tor-rtcompat refactoring.Nick Mathewson2022-01-261-5/+7
|
* Rename `SpawnBlocking` trait to `BlockOn`.Nick Mathewson2022-01-261-3/+3
| | | | | This avoids a future confusion with the new `SpawnBlocking` trait in async_executors v0.5, and better describes what the trait provides.
* Make test_with_all_runtimes cover _all_ the runtimes.Nick Mathewson2022-01-261-46/+69
| | | | | | | | | | | This took some refactoring, so that I wouldn't need to define 9 different versions of the function. It also required that we change the behavior of test_with_all_runtimes slightly, so that it asserts on _any_ failure rather than asserting on most but returning Err() for others. That in turn required changes to a few of its callers. There's probably a better way to do all of this macro business, but this is the best I could find.
* Make the native-tls crate optional.Nick Mathewson2022-01-261-12/+49
| | | | | | | | | | | This commit puts the native-tls crate behind a feature. The feature is off-by-default in the tor-rtcompat crate, but can be enabled either from arti or arti-client. There is an included script that I used to test that tor-rtcompat could build and run its tests with all subsets of its features. Closes #300
* Define aliases for "the best enabled runtime".Nick Mathewson2022-01-261-16/+17
| | | | | This helps us simplify our code in a few ways, and will help even more once native_tls is optional.
* Make current/create functions into runtime member functions.Nick Mathewson2022-01-261-4/+4
| | | | | This should help avoid some amount of temptation towards API proliferation.
* Refactor Runtimes to use separate TLS implementations internally.Nick Mathewson2022-01-191-3/+3
| | | | | This will make it easier to implement them using some other TLS provider as well, without having to duplicate all of our code.
* Add a macro to help with opaque Runtime wrappers.Nick Mathewson2022-01-191-0/+1
| | | | | | | We're soon going to have our different Runtime types be built as CompoundRuntime instances. We don't want to expose that detail, though, so we'll use this macro to make them implement the right traits.
* Add a CompoundRuntime type for runtime construction.Nick Mathewson2022-01-191-0/+3
| | | | | | | | | | | | | This type can solve two problems at once. First, it lets users replace parts of an existing runtime implementation without replacing the whole thing. For example, you can use it to override your TcpProvider implementation to solve problems like #235. Second, we can use it internally to tor-rtcompat to define Runtimes piece-by-piece. Mostly we'll use this to separate our Tls implementations from our implementations of the rest of the Runtime.
* extend lints to include 'clippy::all'Daniel Eades2021-12-281-0/+1
|
* add semicolons if nothing returnedDaniel Eades2021-11-251-1/+2
|
* enable checked_conversions lint.Nick Mathewson2021-10-091-0/+1
|
* Move all crates into a `crates` subdirectory.Nick Mathewson2021-08-271-0/+291
This will cause some pain for now, but now is really the best time to do this kind of thing.