Struct BitRecorder

pub struct BitRecorder<N, E: Endianness> { /* private fields */ }

For recording writes in order to play them back on another writer

Example

use std::io::Write;
use bitstream_io::{BigEndian, BitWriter, BitWrite, BitRecorder};
let mut recorder: BitRecorder<u32, BigEndian> = BitRecorder::new();
recorder.write(1, 0b1).unwrap();
recorder.write(2, 0b01).unwrap();
recorder.write(5, 0b10111).unwrap();
assert_eq!(recorder.written(), 8);
let mut writer = BitWriter::endian(Vec::new(), BigEndian);
recorder.playback(&mut writer);
assert_eq!(writer.into_writer(), [0b10110111]);

Implementations

impl<N: Default + Copy, E: Endianness> BitRecorder<N, E>

pub fn new() -> Self

Creates new recorder

pub fn with_capacity(writes: usize) -> Self

Creates new recorder sized for the given number of writes

pub fn endian(_endian: E) -> Self

Creates new recorder with the given endianness

pub fn written(&self) -> N

Returns number of bits written

pub fn playback<W: BitWrite>(&self, writer: &mut W) -> Result<()>

Plays recorded writes to the given writer

Trait Implementations

impl<N, E> BitWrite for BitRecorder<N, E>

where E: Endianness, N: Copy + From<u32> + AddAssign + Rem<Output = N> + Eq,

fn write_bit(&mut self, bit: bool) -> Result<()>

Writes a single bit to the stream. true indicates 1, false indicates 0

fn write<U>(&mut self, bits: u32, value: U) -> Result<()>

where U: Numeric,

Writes an unsigned value to the stream using the given number of bits.

fn write_out<const BITS: u32, U>(&mut self, value: U) -> Result<()>

where U: Numeric,

Writes an unsigned value to the stream using the given const number of bits.

fn write_signed<S>(&mut self, bits: u32, value: S) -> Result<()>

where S: SignedNumeric,

Writes a twos-complement signed value to the stream with the given number of bits.

fn write_signed_out<const BITS: u32, S>(&mut self, value: S) -> Result<()>

where S: SignedNumeric,

Writes a twos-complement signed value to the stream with the given const number of bits.

fn write_from<V>(&mut self, value: V) -> Result<()>

where V: Primitive,

Writes whole value to the stream whose size in bits is equal to its type’s size.

fn write_as_from<F, V>(&mut self, value: V) -> Result<()>

where F: Endianness, V: Primitive,

Writes whole value to the stream whose size in bits is equal to its type’s size in an endianness that may be different from the stream’s endianness.

fn write_unary0(&mut self, value: u32) -> Result<()>

Writes value number of 1 bits to the stream and then writes a 0 bit. This field is variably-sized.

fn write_unary1(&mut self, value: u32) -> Result<()>

Writes value number of 0 bits to the stream and then writes a 1 bit. This field is variably-sized.

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

Writes the entirety of a byte buffer to the stream.

fn byte_aligned(&self) -> bool

Returns true if the stream is aligned at a whole byte.

fn build<T: ToBitStream>(&mut self, build: &T) -> Result<(), T::Error>

Builds and writes complex type

fn build_with<'a, T: ToBitStreamWith<'a>>( &mut self, build: &T, context: &T::Context, ) -> Result<(), T::Error>

Builds and writes complex type with context

fn byte_align(&mut self) -> Result<()>

Pads the stream with 0 bits until it is aligned at a whole byte. Does nothing if the stream is already aligned.

impl<N: Default, E: Default + Endianness> Default for BitRecorder<N, E>

fn default() -> BitRecorder<N, E>

Returns the “default value” for a type.

impl<N, E> HuffmanWrite<E> for BitRecorder<N, E>

where E: Endianness, N: Copy + From<u32> + AddAssign + Rem<Output = N> + Eq,

fn write_huffman<T>( &mut self, tree: &WriteHuffmanTree<E, T>, symbol: T, ) -> Result<()>

where T: Ord + Copy,

Writes Huffman code for the given symbol to the stream.