Crate fixed_buffer_tokio
source · [−]Expand description
NOT MAINTAINED
This crate was replaced by
fixed-buffer
crates’s tokio
feature
and read-write-ext-tokio
.
This is a Rust library with fixed-size buffers, useful for network protocol parsers and file parsers.
This is the tokio async version of fixed-buffer
.
Features
- Write bytes to the buffer and read them back
- Use it to read a stream, search for a delimiter, and save leftover bytes for the next read.
- Does not allocate memory
- Depends only on
std
,tokio
, andfixed-buffer
. - No macros
- Good test coverage (98%)
forbid(unsafe_code)
Documentation
https://docs.rs/fixed-buffer-tokio
Examples
For a complete example, see
tests/server.rs
.
Alternatives
Changelog
- v0.3.4 - Update “not maintained” message.
- v0.3.3 - No longer maintained.
- v0.3.2 - Update docs
- v0.3.1 - Support Tokio 1
- v0.3.0 - Breaking API changes:
- Change type parameter to const buffer size. Example:
FixedBuf<1024>
. - Remove
new
arg. - Remove
capacity
. - Change
writable
return type to&mut [u8]
.
- Change type parameter to const buffer size. Example:
- v0.1.1 - Add badges to readme
- v0.1.0 - First published version
Release Process
- Edit
Cargo.toml
and bump version number. - Run
../release.sh
Structs
A newtype that wraps
FixedBuf
and implements
tokio::io::AsyncRead
and
tokio::io::AsyncWrite
.
A wrapper for a pair of structs.
The first implements AsyncRead
.
The second implements
AsyncRead
+AsyncWrite
.
Wraps a struct that implements
AsyncRead
+AsyncWrite
.
Passes through reads and writes to the struct.
Limits the number of bytes that can be read.