mirrors/arti.git/crates/tor-rtcompat/src/traits.rs, branch derive-traits

Fix rustdoc "skip this" markup

2022-02-24T16:19:28Z

tor-rtcompat: Provide TLS wrapping for all streams

2022-02-24T14:26:38Z

Now all of the runtime types we provide all impl ~~TlsProvider ~~where S: ... rather than merely TlsProvider. And we document and intent to perhaps require this in the future.~~~~

Rename `SpawnBlocking` trait to `BlockOn`.

2022-01-26T19:06:58Z
This avoids a future confusion with the new `SpawnBlocking` trait in async_executors v0.5, and better describes what the trait provides.

More comments on the limitations of tor-rtcompat's TLS API

2022-01-25T18:16:39Z
Also, more comments on why these limitations are safe within the context of Tor, but you wouldn't want to use them elsewhere.

Comment-only: document sni_hostname more.

2022-01-25T18:16:39Z
Previously we expected the reader to automatically know why it was called "SNI", which really isn't fair.

Make TlsConnector wrap TCP connections, not create its own

2021-12-07T17:00:40Z
`tor-rtcompat`'s `TlsConnector` trait previously included a method to create a TLS-over-TCP connection, which implied creating a TCP stream inside that method. This commit changes that, and makes the function wrap a TCP stream, as returned from the runtime's `TcpProvider` trait implementation, instead. This means you can actually override `TcpProvider` and have it apply to *all* connections Arti makes, which is useful for issues like arti#235 and other cases where you want to have a custom TCP stream implementation. This required updating the mock TCP/TLS types in `tor-rtmock` slightly; due to the change in API, we now store whether a `LocalStream` should actually be a TLS stream inside the stream itself, and check this property on reads/writes in order to detect misuse. The fake TLS wrapper checks this property and removes it in order to "wrap" the stream, making reads and writes work again.

Improve some documentation links

2021-10-29T12:39:04Z
Instead of putting a fully qualified name in the text, in most cases we should just use the short name of the type or function we're referring to. In other words, instead of saying [`crate::module::Foo`], we should typically say [`Foo`](crate::module::Foo).

Clarify that new SleepProvider methods are testing-only.

2021-10-26T17:06:10Z

Overhaul the way WaitFor and the MockSleepProvider work

2021-10-26T15:33:23Z
Instead of racily advancing time forward, this commit attempts to rework how WaitFor works, such that it makes advances when all sleeper futures that have been created have been polled (by handing the MockSleepRuntime a Waker with which to wake up the WaitFor). The above described mechanics work well enough for the double timeout test, but fail in the presence of code that spawns asynchronous / background tasks that must make progress before time is advanced for the test to work properly. In order to deal with these cases, a set of APIs are introduced in order to block time from being advanced until some code has run, and a carveout added in order to permit small advances in time where required. (In some cases, code needed to be hacked up a bit in order to be made properly testable using these APIs; the `MockablePlan` trait included in here is somewhat unfortunate.) This should fix arti#149.

Move all crates into a `crates` subdirectory.

2021-08-27T13:53:09Z
This will cause some pain for now, but now is really the best time to do this kind of thing.