#buffer #tokio #fixed-size #byte-buffer #network-protocol #async-read #stream

fixed-buffer-tokio

NOT MAINTAINED. This crate was replaced by the fixed-buffer crate with tokio feature.

7 releases

0.3.4 Mar 21, 2022
0.3.3 Mar 21, 2022
0.3.2 Oct 9, 2021
0.1.1 Dec 9, 2020

#21 in #async-read

Apache-2.0

94KB
1.5K SLoC

fixed-buffer-tokio

NOT MAINTAINED

This crate was replaced by fixed-buffer crates's tokio feature and read-write-ext-tokio.


crates.io version license: Apache 2.0 unsafe forbidden pipeline status

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, and fixed-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].
  • v0.1.1 - Add badges to readme
  • v0.1.0 - First published version

Release Process

  1. Edit Cargo.toml and bump version number.
  2. Run ../release.sh

License: Apache-2.0

Dependencies

~2.1–7.5MB
~49K SLoC