Struct BitCounter

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

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

Example

use tokio_bitstream_io::{BigEndian, BitWrite, BitCounter};
let mut writer: BitCounter<u32, BigEndian> = BitCounter::new();
writer.write(1, 0b1).await.unwrap();
writer.write(2, 0b01).await.unwrap();
writer.write(5, 0b10111).await.unwrap();
assert_eq!(writer.written(), 8);

Implementations

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

pub fn new() -> Self

Creates new counter

pub fn written(&self) -> N

Returns number of bits written

Trait Implementations

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

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

fn write_bit<'life0, 'async_trait>( &'life0 mut self, _bit: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn write<'life0, 'async_trait, U>( &'life0 mut self, bits: u32, value: U, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where U: Numeric + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

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

fn write_signed<'life0, 'async_trait, S>( &'life0 mut self, bits: u32, value: S, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where S: SignedNumeric + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

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

fn write_unary1<'life0, 'async_trait>( &'life0 mut self, value: u32, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn write_unary0<'life0, 'async_trait>( &'life0 mut self, value: u32, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn write_bytes<'life0, 'life1, 'async_trait>( &'life0 mut self, buf: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

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 byte_align<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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 BitCounter<N, E>

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

Returns the “default value” for a type.

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

where E: Endianness, N: AddAssign + From<u32> + Send + Sync,

fn write_huffman<'life0, 'life1, 'async_trait, T>( &'life0 mut self, tree: &'life1 WriteHuffmanTree<E, T>, symbol: T, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where T: Ord + Copy + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes Huffman code for the given symbol to the stream.