Struct BitWriter

pub struct BitWriter<W: Write> { /* private fields */ }

Bitwise writer formed by wrapping a bytewise io::Write. Bits are written in big-endian order. Bytes are filled with zeroes for padding.

Implementations

impl<W: Write> BitWriter<W>

pub fn new(w: W) -> BitWriter<W>

Create a bitwise writer from a bytewise one. Equivalent to using From.

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

Write a single bit.

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

Write out all cached bits. This may write up to two bytes and flushes the underlying io::Write.

pub fn n_total_written(&self) -> usize

Return total number of written bits.

pub fn write_bits_be(&mut self, n: u64, len: usize) -> Result<usize>

Write up to 64 bits in big-endian order. The first len many least significant bits from n are written.

Returns the number of written bits.

Trait Implementations

impl<W: Write> From<W> for BitWriter<W>

fn from(w: W) -> Self

Converts to this type from the input type.

impl<W: Write> Write for BitWriter<W>

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

Does not write out cached bits (i.e. bits written since the last byte boundary). To do this you must call BitWriter::flush_all().

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

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

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.