Struct BitWriter 

pub struct BitWriter { /* private fields */ }

A sink that appends values at arbitrary bit offsets in a chosen BitOrder (MSB-first by default), growing a byte buffer (the final partial byte is zero-padded).

Examples

use bnb::{BitWriter, u4, u12};

let mut w = BitWriter::new();
w.write(u4::new(0xA)).unwrap();
w.write(u12::new(0xBCD)).unwrap();
assert_eq!(w.bit_len(), 16);
assert_eq!(w.into_bytes(), [0xAB, 0xCD]);

Implementations

impl BitWriter

pub fn new() -> Self

An empty MSB-first, big-endian writer.

pub fn with_order(order: BitOrder) -> Self

An empty writer in the given bit order (big-endian).

pub fn with_layout(layout: Layout) -> Self

An empty writer in the given Layout (bit + byte order).

pub fn bit_len(&self) -> usize

Bits written so far.

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

Appends the low n (<= 128) bits of value, in the writer’s bit order.

Errors

ErrorKind::TooWide if n > 128.

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

Appends one Bits value of its declared width, applying the byte order to a byte-multiple value.

Errors

As write_bits.

pub fn into_bytes(self) -> Vec<u8>

Consumes the writer, returning the packed bytes.

Trait Implementations

impl Clone for BitWriter

fn clone(&self) -> BitWriter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitWriter

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

Formats the value using the given formatter.

impl Default for BitWriter

fn default() -> BitWriter

Returns the “default value” for a type.

impl Sink for BitWriter

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

Appends the low n (<= 128) bits of value, MSB-first.

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 write<T: Bits>(&mut self, value: T) -> Result<(), BitError>

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

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

where Self: Sized,

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.