mirrors/arti.git/crates/tor-proto/src/stream, branch arti-v0.0.1mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v0.0.12021-10-29T13:06:06ZImprove docs of more (potentially re-exported) arti-client types2021-10-29T13:06:06Zetator@eta.st2021-10-29T13:06:06Zurn: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.
Use correct link for AsyncWriteExt::flush2021-10-29T00:48:54ZNick Mathewsonnickm@torproject.org2021-10-29T00:48:54Zurn:sha1:2057142671c4ced0828c85b01dae02b9b1f0b172DataStream: document the importance of flush().2021-10-29T00:21:35ZNick Mathewsonnickm@torproject.org2021-10-29T00:19:25Zurn:sha1:c8f65e532e136e76eb0de44eeba83aa2c723c994Replace references to arti-client in the documentation.2021-10-21T18:22:21ZNick Mathewsonnickm@torproject.org2021-10-21T18:19:34Zurn:sha1:730be38867c82b8d5ca76a569e1b1175ddf75cd4Also implement tokio Async{Read,Write} on Data{Reader,Writer}.2021-10-19T19:49:49ZNick Mathewsonnickm@torproject.org2021-10-19T19:49:49Zurn:sha1:fb2c7cb85a76acb2a80ae467a635ddb52d80a363
This will let callers use the tokio traits on these types too, if
they call `split()` on the DataStream.
(Tokio also has a `tokio::io::split()` method, but it requires a
lock whereas `DataStream::split()` doesn't.)
Add a little documentation about when you'll need the tokio trait.2021-10-19T19:48:55ZNick Mathewsonnickm@torproject.org2021-10-19T19:48:55Zurn:sha1:a9a9f70eb9b8ff7ad5506fed60aaadab1b5c3572tor-proto: implement tokio Async{Read, Write} traits conditionally2021-10-19T18:59:29Zetator@eta.st2021-10-19T16:26:52Zurn:sha1:ccd1d36e90dac9f282cdb7199d44f89004f0a070
futures::io::AsyncRead (and Write) isn't the same thing as tokio::io::AsyncRead,
which is a somewhat annoying misfeature of the Rust async ecosystem (!).
To mitigate this somewhat for people trying to use the `DataStream` struct with
tokio, implement the tokio versions of the above traits using `tokio-util`'s
compat layer, if a crate feature (`tokio`) is enabled.
Use append in place of extend_from_slice in DataReaderImpl::add_data.2021-10-17T16:31:10ZNick Mathewsonnickm@torproject.org2021-10-17T16:31:10Zurn:sha1:9df9706010020d5434b0268fbbe23c2da3c9bfbb
Suggested by @cheako.
Fix typos2021-09-07T04:52:00ZJani Monosesjani.monoses@gmail.com2021-09-07T04:52:00Zurn:sha1:25b4421fa6de950a3c0525c472b416b8f18c16f9Move all crates into a `crates` subdirectory.2021-08-27T13:53:09ZNick Mathewsonnickm@torproject.org2021-08-27T13:53:09Zurn:sha1:557a0ff40b3731d4690767de27010bbeff08777d
This will cause some pain for now, but now is really the best time
to do this kind of thing.