Struct WriteBits 

pub struct WriteBits<W> { /* private fields */ }

Buffered bit-level writer that wraps an io::Write byte stream.

Implementations

impl<W> WriteBits<W>

pub fn new(write: W) -> Self

Creates a new WriteBits wrapping the given writer.

impl<W> WriteBits<W>

where W: Write,

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

Write one bit to the stream. Returns Ok(()) if the bit was written successfully. Returns Err if the writer returned an error on write or if the writer is exhausted.

pub fn write_bits( &mut self, buffer: &[u8], bit_offset: usize, bit_len: usize, ) -> Result<usize>

Write bits from the slice. bit_offset specifies the bit offset in the buffer. bit_len specifies number of bits to write.

Returns number of bits written. It would be the bit_len. Unless writer is exhausted.

pub fn write_all_bits( &mut self, buffer: &[u8], bit_offset: usize, bit_len: usize, ) -> Result<()>

Writes exactly bit_len bits from buffer starting at bit_offset.

Unlike write_bits, this retries on partial writes and returns an error if the writer cannot accept all bits.

pub fn finish(&mut self) -> Result<()>

Flushes any remaining buffered bits to the underlying writer, padding the last byte with zeros if necessary.

Trait Implementations

impl<W> Write for WriteBits<W>

where W: Write,

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.