summaryrefslogtreecommitdiff
path: root/crates/tor-proto
Commit message (Collapse)AuthorAgeFilesLines
* Bump all crate versions to 0.0.1Nick Mathewson2021-10-291-8/+8
|
* Improve docs of more (potentially re-exported) arti-client typeseta2021-10-291-16/+48
| | | | | | | | | | | | | | | | | | | | | 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::flushNick Mathewson2021-10-281-1/+1
|
* DataStream: document the importance of flush().Nick Mathewson2021-10-281-3/+12
|
* Update our disclaimers and limitations sections.Nick Mathewson2021-10-272-9/+1
|
* s/arti-arti-client/arti-client/ and regenerate readme filesNick Mathewson2021-10-251-2/+2
|
* Replace references to arti-client in the documentation.Nick Mathewson2021-10-212-3/+3
|
* Remove #![allow(clippy::unnecessary_wraps)] in tor-proto.Nick Mathewson2021-10-211-1/+0
|
* Also implement tokio Async{Read,Write} on Data{Reader,Writer}.Nick Mathewson2021-10-191-5/+31
| | | | | | | | 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.Nick Mathewson2021-10-191-0/+7
|
* tor-proto: implement tokio Async{Read, Write} traits conditionallyeta2021-10-192-0/+37
| | | | | | | | | 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.Nick Mathewson2021-10-171-2/+2
| | | | Suggested by @cheako.
* enable checked_conversions lint.Nick Mathewson2021-10-091-0/+1
|
* Use subtle and some refactoring to remove branches in ntorNick Mathewson2021-10-013-22/+54
| | | | Closes #163
* Typo fixesNick Mathewson2021-09-091-2/+2
|
* Fix clippy warnings in tests with --all-featuresNick Mathewson2021-09-082-10/+9
|
* fix/silence clippy lints in test modulesDaniel Eades2021-09-0816-10/+25
|
* Fix typosJani Monoses2021-09-072-2/+2
|
* Move all crates into a `crates` subdirectory.Nick Mathewson2021-08-2735-0/+9842
This will cause some pain for now, but now is really the best time to do this kind of thing.