Struct 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.

For additional flexibility, this structures implements std::io::Write. Note that because of coherence rules it is not possible to implement std::io::Write for a generic BitWrite.

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<usize, 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, R: BitRead<F>>( &mut self, bit_read: &mut R, n: u64, ) -> Result<(), CopyError<R::Error, Self::Error>>

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<usize, 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, R: BitRead<F>>( &mut self, bit_read: &mut R, n: u64, ) -> Result<(), CopyError<R::Error, Self::Error>>

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

where WW: MemSize + WordWrite, WW::Word: MemSize, usize: MemSize, PhantomData<(E, WP)>: MemSize,

type Copy = False

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<E: Endianness, WW, WP: WriteParams> MemDbgImpl for BufBitWriter<E, WW, WP>

where WW: MemDbgImpl + WordWrite, WW::Word: MemDbgImpl, usize: MemDbgImpl, PhantomData<(E, WP)>: MemDbgImpl,

fn _mem_dbg_rec_on( &self, _memdbg_writer: &mut impl Write, _memdbg_total_size: usize, _memdbg_max_depth: usize, _memdbg_prefix: &mut String, _memdbg_is_last: bool, _memdbg_flags: DbgFlags, ) -> Result

fn _mem_dbg_depth_on( &self, writer: &mut impl Write, total_size: usize, max_depth: usize, prefix: &mut String, field_name: Option<&str>, is_last: bool, padded_size: usize, flags: DbgFlags, ) -> Result<(), Error>

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

where WW: MemSize + WordWrite, WW::Word: MemSize, usize: MemSize, PhantomData<(E, WP)>: MemSize,

fn mem_size(&self, _memsize_flags: SizeFlags) -> usize

Returns the (recursively computed) overall memory size of the structure in bytes.

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

where u64: CastableInto<WW::Word>,

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

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

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

where u64: CastableInto<WW::Word>,

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

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

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: usize) -> 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: usize) -> Result<usize, Self::Error>

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