https://github.com/jonhoo/async-bincode

Asynchronous access to a bincode-encoded item stream.
https://github.com/jonhoo/async-bincode

Last synced: 17 days ago
JSON representation

Asynchronous access to a bincode-encoded item stream.

• Host: GitHub
• URL: https://github.com/jonhoo/async-bincode
• Owner: jonhoo
• License: apache-2.0
• Created: 2018-05-23T17:04:19.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-02-04T17:01:31.000Z (9 months ago)
• Last Synced: 2024-10-14T20:56:59.041Z (29 days ago)
• Language: Rust
• Size: 128 KB
• Stars: 67
• Watchers: 6
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# async-bincode

[![Crates.io](https://img.shields.io/crates/v/async-bincode.svg)](https://crates.io/crates/async-bincode)

[![Documentation](https://docs.rs/async-bincode/badge.svg)](https://docs.rs/async-bincode/)

Asynchronous access to a bincode-encoded item stream.

This crate enables you to asynchronously read from a bincode-encoded stream, or write

bincoded-encoded values. `bincode` does not support this natively, as it cannot easily [resume

from stream errors while encoding or decoding](https://github.com/TyOverby/bincode/issues/229).

`async-bincode` works around that on the receive side by buffering received bytes until a full

element's worth of data has been received, and only then calling into bincode. To make this

work, it relies on the sender to prefix each encoded element with its encoded size.

On the write side, `async-bincode` buffers the serialized values, and asynchronously sends the

resulting bytestream. **Important:** Only one element at a time is written to the output writer.

It is recommended to use a BufWriter in front of the output to batch write operations to the

underlying writer. The marker trait `AsyncDestination` can be used to automatically add the

length prefix required by an `async-bincode` receiver.