Struct dsi_bitstream::impls::BufBitWriter

pub struct BufBitWriter<E: Endianness, WW: WordWrite, WP: WriteParams = DefaultWriteParams> { /* private fields */ }

An implementation of BitWrite for a WordWrite.

This implementation uses a bit buffer to store bits that are not yet written. The size of the bit buffer is the size of the word used by the WordWrite, which on most platform should be usize.

The additional type parameter WP is used to select the parameters for the instantanous codes, but the casual user should be happy with the default value. See WriteParams for more details.

Implementations

impl<E: Endianness, WW: WordWrite, WP: WriteParams> BufBitWriter<E, WW, WP>

where BufBitWriter<E, WW, WP>: BitWrite<E>,

pub fn new(backend: WW) -> Self

Create a new BufBitWriter around a WordWrite.

Example

use dsi_bitstream::prelude::*;
let buffer = Vec::<usize>::new();
let word_writer = MemWordWriterVec::new(buffer);
let mut buf_bit_writer = <BufBitWriter<BE, _>>::new(word_writer);

pub fn into_inner(self) -> Result<WW, <Self as BitWrite<E>>::Error>

Return the backend, consuming this writer after flushing it.

Trait Implementations

impl<WW: WordWrite, WP: WriteParams> BitWrite<BigEndian> for BufBitWriter<BE, WW, WP>

where u64: CastableInto<WW::Word>,

type Error = <WW as WordWrite>::Error

fn flush(&mut self) -> Result<(), Self::Error>

Flush the buffer, consuming the bit stream.

fn write_bits( &mut self, value: u64, n_bits: usize ) -> Result<usize, Self::Error>

Write the lowest n bits of value to the stream and return the number of bits written, that is, n.

fn write_unary(&mut self, value: u64) -> Result<usize, Self::Error>

Write value as a unary code to the stream and return the number of bits written, that is, value plus one.

fn copy_from<F: Endianness>( &mut self, bit_read: &mut impl BitRead<F>, n: u64 ) -> Result<(), Box<dyn Error + Send + Sync + 'static>>

impl<WW: WordWrite, WP: WriteParams> BitWrite<LittleEndian> for BufBitWriter<LE, WW, WP>

where u64: CastableInto<WW::Word>,

type Error = <WW as WordWrite>::Error

fn flush(&mut self) -> Result<(), Self::Error>

Flush the buffer, consuming the bit stream.

fn write_bits( &mut self, value: u64, n_bits: usize ) -> Result<usize, Self::Error>

Write the lowest n bits of value to the stream and return the number of bits written, that is, n.

fn write_unary(&mut self, value: u64) -> Result<usize, Self::Error>

Write value as a unary code to the stream and return the number of bits written, that is, value plus one.

fn copy_from<F: Endianness>( &mut self, bit_read: &mut impl BitRead<F>, n: u64 ) -> Result<(), Box<dyn Error + Send + Sync + 'static>>

impl<E: Debug + Endianness, WW: Debug + WordWrite, WP: Debug + WriteParams> Debug for BufBitWriter<E, WW, WP>

where WW::Word: Debug,

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

Formats the value using the given formatter.

impl<WR: WordWrite, DC: WriteParams> DeltaWrite<BigEndian> for BufBitWriter<BigEndian, WR, DC>

where u64: CastableInto<WR::Word>,

fn write_delta(&mut self, value: u64) -> Result<usize, Self::Error>

impl<WR: WordWrite, DC: WriteParams> DeltaWrite<LittleEndian> for BufBitWriter<LittleEndian, WR, DC>

where u64: CastableInto<WR::Word>,

fn write_delta(&mut self, value: u64) -> Result<usize, Self::Error>

impl<E: Endianness, WW: WordWrite, WP: WriteParams> Drop for BufBitWriter<E, WW, WP>

fn drop(&mut self)

Executes the destructor for this type.

impl<WR: WordWrite> GammaWrite<BigEndian> for BufBitWriter<BigEndian, WR, DefaultWriteParams>

where u64: CastableInto<WR::Word>,

fn write_gamma(&mut self, value: u64) -> Result<usize, Self::Error>

impl<WR: WordWrite> GammaWrite<LittleEndian> for BufBitWriter<LittleEndian, WR, DefaultWriteParams>

where u64: CastableInto<WR::Word>,

fn write_gamma(&mut self, value: u64) -> Result<usize, Self::Error>

impl<WR: WordWrite, DC: WriteParams> ZetaWrite<BigEndian> for BufBitWriter<BigEndian, WR, DC>

where u64: CastableInto<WR::Word>,

fn write_zeta(&mut self, value: u64, k: u64) -> Result<usize, Self::Error>

fn write_zeta3(&mut self, value: u64) -> Result<usize, Self::Error>

impl<WR: WordWrite, DC: WriteParams> ZetaWrite<LittleEndian> for BufBitWriter<LittleEndian, WR, DC>

where u64: CastableInto<WR::Word>,

fn write_zeta(&mut self, value: u64, k: u64) -> Result<usize, Self::Error>

fn write_zeta3(&mut self, value: u64) -> Result<usize, Self::Error>