Struct BytesWriter 

pub struct BytesWriter { /* private fields */ }

Available on crate feature bytes only.

A Sink that encodes into a bytes::BytesMut; freeze hands off a zero-copy Bytes.

Implementations

impl BytesWriter

pub fn new() -> Self

An empty MSB-first, big-endian writer.

pub fn with_layout(layout: Layout) -> Self

An empty writer in the given Layout.

pub fn freeze(self) -> Bytes

The encoded bytes as a zero-copy Bytes (the final partial byte is zero-padded).

Trait Implementations

impl Clone for BytesWriter

fn clone(&self) -> BytesWriter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BytesWriter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BytesWriter

fn default() -> BytesWriter

Returns the “default value” for a type.

impl Sink for BytesWriter

fn write_bits(&mut self, value: u128, n: u32) -> Result<(), BitError>

Appends the low n (<= 128) bits of value, in the sink’s bit order (MSB-first by default).

fn bit_pos(&self) -> usize

The number of bits written so far.

fn byte_order(&self) -> ByteOrder

The byte order applied to a byte-multiple value (default big-endian).

fn bit_order(&self) -> BitOrder

The bit order this sink writes in (default MSB-first). Paired with byte_order exactly as on Source: each bit order has a natural byte layout (big-endian under MSB, little-endian under LSB), and only the opposite declaration swaps a byte-multiple value.

fn scratch(&mut self) -> Option<&mut dyn Any>

A type-erased, encode-scoped scratch value for codecs that need mutable state shared across a whole message’s fields — a back-reference / compression dictionary (e.g. DNS name compression). Recover the concrete type with downcast_mut.

fn write<T: Bits>(&mut self, value: T) -> Result<(), BitError>

Appends one Bits value of its declared width, applying the byte order.

fn write_bytes(&mut self, bytes: &[u8]) -> Result<(), BitError>

Appends a run of bytes — the bulk dual of Source::read_bytes, replacing the per-byte write(b)? loop in custom codecs. Works at any bit offset.

fn as_write(&mut self) -> SinkWriter<'_, Self>

where Self: Sized,

Available on crate feature std only.

Borrows this sink as a std::io::Write — the dual of Source::as_read, for handing the cursor to std::io-based code from a #[bw(write_with = …)]. Writes 8 bits per byte; see SinkWriter. Only with the std feature.