Struct BitCounter

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

👎Deprecated since 4.0.0: use of BitsWritten is preferred

For counting the number of bits written but generating no output.

Example

use bitstream_io::{BigEndian, BitWrite, BitCounter};
let mut writer: BitCounter<u32, BigEndian> = BitCounter::new();
writer.write_var(1, 0b1u8).unwrap();
writer.write_var(2, 0b01u8).unwrap();
writer.write_var(5, 0b10111u8).unwrap();
assert_eq!(writer.written(), 8);

Implementations

impl<N: Default, E: Endianness> BitCounter<N, E>

pub fn new() -> Self

Creates new counter

impl<N: Copy, E: Endianness> BitCounter<N, E>

pub fn written(&self) -> N

Returns number of bits written

impl<N, E: Endianness> BitCounter<N, E>

pub fn into_written(self) -> N

Returns number of bits written

Trait Implementations

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

where E: Endianness, N: Counter,

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

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

fn write_const<const BITS: u32, const VALUE: u32>(&mut self) -> Result<()>

Writes the given constant value to the stream with the given number of bits.

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

where U: UnsignedInteger,

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

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

where S: SignedInteger,

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

fn write_unsigned_counted<const MAX: u32, U>( &mut self, count: BitCount<MAX>, value: U, ) -> Result<()>

where U: UnsignedInteger,

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

fn write_signed_counted<const MAX: u32, S>( &mut self, bits: impl TryInto<SignedBitCount<MAX>>, value: S, ) -> Result<()>

where S: SignedInteger,

Writes an unsigned value to the stream with the given 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 pad(&mut self, bits: u32) -> Result<()>

Pads the stream by writing 0 over the given number of bits.

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

Writes the entirety of a byte buffer to the stream.

fn write_unary<const STOP_BIT: u8>(&mut self, value: u32) -> Result<()>

Writes value number of non STOP_BIT bits to the stream and then writes a STOP_BIT. This field is variably-sized. STOP_BIT must be 0 or 1.

fn byte_aligned(&self) -> bool

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

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

where I: Integer,

Writes a signed or unsigned value to the stream using the given const number of bits.

fn write_var<I>(&mut self, bits: u32, value: I) -> Result<()>

where I: Integer,

Writes a signed or unsigned value to the stream using the given number of bits.

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

where U: UnsignedInteger,

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

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

where S: SignedInteger,

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

fn write_count<const MAX: u32>(&mut self, _: BitCount<MAX>) -> Result<()>

Writes the given bit count to the stream with the necessary maximum number of bits.

fn write_counted<const MAX: u32, I>( &mut self, bits: BitCount<MAX>, value: I, ) -> Result<()>

where I: Integer + Sized,

Writes a signed or unsigned value to the stream with the given number of bits.

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.

fn write_huffman<T>(&mut self, value: T::Symbol) -> Result<()>

where T: ToBits,

Given a symbol, writes its representation to the output stream as bits. Generates no output if the symbol isn’t defined in the Huffman tree.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this BitWrite

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

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

Returns the “default value” for a type.