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 platforms should be usize.

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

The convenience functions from_path and from_file (requiring the std feature) create a BufBitWriter around a buffered file writer.

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

Panics on drop

The Drop implementation flushes the buffer, which requires writing to the backend. If the backend write fails, the drop will panic. To handle errors gracefully, call flush or into_inner explicitly before dropping.

Implementations

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

pub const fn new(backend: WW) -> Self

Creates a new BufBitWriter around a WordWrite.

Examples

#[cfg(not(feature = "std"))]
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);

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

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

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

Returns the backend, consuming this writer after flushing it.

Trait Implementations

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

where u64: AsPrimitive<WW::Word>,

type Error = <WW as WordWrite>::Error

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

Flushes the buffer, consuming the bit stream.

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

Writes the lowest num_bits bits of value to the stream and returns the number of bits written, that is, num_bits.

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

Writes n as a unary code to the stream and returns the number of bits written, that is, n plus one.

fn copy_from<F: Endianness, R: BitRead<F>>( &mut self, bit_read: &mut R, n: u64, ) -> Result<(), CopyError<R::Error, Self::Error>>

Copy bits from a BitRead stream to self.

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

where u64: AsPrimitive<WW::Word>,

type Error = <WW as WordWrite>::Error

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

Flushes the buffer, consuming the bit stream.

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

Writes the lowest num_bits bits of value to the stream and returns the number of bits written, that is, num_bits.

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

Writes n as a unary code to the stream and returns the number of bits written, that is, n plus one.

fn copy_from<F: Endianness, R: BitRead<F>>( &mut self, bit_read: &mut R, n: u64, ) -> Result<(), CopyError<R::Error, Self::Error>>

Copy bits from a BitRead stream to self.

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, WP: WriteParams> DeltaWrite<BigEndian> for BufBitWriter<BigEndian, WR, WP>

where u64: AsPrimitive<WR::Word>,

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

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

where u64: AsPrimitive<WR::Word>,

fn write_delta(&mut self, n: 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<E: Endianness, WW, WP: WriteParams> FlatType for BufBitWriter<E, WW, WP>

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

type Flat = False

impl<WR: WordWrite, WP: WriteParams> GammaWrite<BigEndian> for BufBitWriter<BigEndian, WR, WP>

where u64: AsPrimitive<WR::Word>,

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

impl<WR: WordWrite, WP: WriteParams> GammaWrite<LittleEndian> for BufBitWriter<LittleEndian, WR, WP>

where u64: AsPrimitive<WR::Word>,

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

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

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

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, _memdbg_refs: &mut HashSet<usize>, ) -> 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, dbg_refs: &mut HashSet<usize>, ) -> Result<(), Error>

fn _mem_dbg_depth_on_impl( &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, dbg_refs: &mut HashSet<usize>, ref_display: RefDisplay, ) -> Result<(), Error>

Internal implementation for depth display.

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

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

fn mem_size_rec( &self, _memsize_flags: SizeFlags, _memsize_refs: &mut HashMap<usize, usize>, ) -> usize

Recursive implementation that tracks visited references for deduplication.

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

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

impl<WR: WordWrite, WP: WriteParams> OmegaWrite<BigEndian> for BufBitWriter<BigEndian, WR, WP>

where u64: AsPrimitive<WR::Word>,

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

impl<WR: WordWrite, WP: WriteParams> OmegaWrite<LittleEndian> for BufBitWriter<LittleEndian, WR, WP>

where u64: AsPrimitive<WR::Word>,

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

impl<WR: WordWrite, WP: WriteParams> PiWrite<BigEndian> for BufBitWriter<BigEndian, WR, WP>

where u64: AsPrimitive<WR::Word>,

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

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

impl<WR: WordWrite, WP: WriteParams> PiWrite<LittleEndian> for BufBitWriter<LittleEndian, WR, WP>

where u64: AsPrimitive<WR::Word>,

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

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

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

where u64: AsPrimitive<WW::Word>,

Available on crate feature std only.

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: AsPrimitive<WW::Word>,

Available on crate feature std only.

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, WP: WriteParams> ZetaWrite<BigEndian> for BufBitWriter<BigEndian, WR, WP>

where u64: AsPrimitive<WR::Word>,

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

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

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

where u64: AsPrimitive<WR::Word>,

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

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