Crate transmog_async

source ·
Expand description

Asynchronous access to a Transmog-encoded item stream.

transmog-async forbids unsafe code crate version Documentation for main branch

This crate enables you to asynchronously read from a Transmog-encoded stream, or write transmog-encoded values. Most serialization format do not natively support serializing and deserializing in an asynchronous environment.

Transmog 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 the underlying Format. To make this work, it relies on the sender to prefix each encoded element with its encoded size.

On the write side, Transmog buffers the serialized values, and asynchronously sends the resulting bytestream.

This crate has been adapted from async-bincode to generically support the Format trait.

Re-exports

  • pub use transmog;
  • pub use self::writer::TransmogWriterFor;

Structs

  • AsyncDestination
    A marker that indicates that the wrapping type is compatible with TransmogReader.
  • Builder
    Builder helper to specify types without the need of turbofishing.
  • SyncDestination
    A marker that indicates that the wrapping type is compatible with stock Transmog receivers.
  • TransmogReader
    A wrapper around an asynchronous reader that produces an asynchronous stream of Transmog-decoded values.
  • TransmogStream
    A wrapper around an asynchronous stream that receives and sends bincode-encoded values.
  • TransmogWriter
    A wrapper around an asynchronous sink that accepts, serializes, and sends Transmog-encoded values.

Type Definitions