Struct CompressStream

pub struct CompressStream<'a, T: MutBits> { /* private fields */ }

Available on crate feature miniz only.

Implementations

impl<'a, T: MutBits> CompressStream<'a, T>

pub fn new(writer: BitsWrapper<'a, T>) -> Self

pub fn write_value<V: WriteToBEBits + Copy>( &mut self, value: V, ) -> Result<(), Error>

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

pub fn written(&self) -> u64

Trait Implementations

impl<'a, B: MutBits> Drop for CompressStream<'a, B>

fn drop(&mut self)

Make sure the buffer is fully flushed on drop

impl<'a, B: MutBits> MutBits for CompressStream<'a, B>

fn write_u8(&mut self, val: u8) -> Result<(), Error>

Writes a single u8

fn write_be_u16(&mut self, val: u16) -> Result<(), Error>

Writes a single u16 in big-endian order, 2 bytes, MSB first.

fn write_be_u32(&mut self, val: u32) -> Result<(), Error>

Writes a single u32 in big-endian order, 4 bytes, MSB first.

fn write_be_u64(&mut self, val: u64) -> Result<(), Error>

Writes a single u64 in big-endian order, 8 bytes, MSB first.

fn write_be_u128(&mut self, val: u128) -> Result<(), Error>

Writes a single u128 in big-endian order, 16 bytes, MSB first.

fn write_i8(&mut self, val: i8) -> Result<(), BitsError>

Writes a single i8

fn write_bool(&mut self, val: bool) -> Result<(), BitsError>

Writes 1u8 if true, 0u8 if false

fn write_be_utf8_char(&mut self, val: char) -> Result<usize, BitsError>

Encodes the character as UTF-8, and writes anywhere from 1-4 bytes. The number of bytes written is returned.

fn write_le_u16(&mut self, val: u16) -> Result<(), BitsError>

Writes a single u16 in little-endian order, 2 bytes, LSB first.

fn write_le_u32(&mut self, val: u32) -> Result<(), BitsError>

Writes a single u32 in little-endian order, 4 bytes, LSB first.

fn write_le_u64(&mut self, val: u64) -> Result<(), BitsError>

Writes a single u64 in little-endian order, 8 bytes, LSB first.

fn write_le_u128(&mut self, val: u128) -> Result<(), BitsError>

Writes a single u128 in little-endian order, 16 bytes, LSB first.

fn write_be_f32(&mut self, val: f32) -> Result<(), BitsError>

Writes a single f32 in standard IEEE754 format, 4 bytes

fn write_le_f32(&mut self, val: f32) -> Result<(), BitsError>

Writes a single f32 in reversed IEEE754 format, 4 bytes

fn write_be_f64(&mut self, val: f64) -> Result<(), BitsError>

Writes a single u16 in standard IEEE754 format, 8 bytes

fn write_le_f64(&mut self, val: f64) -> Result<(), BitsError>

Writes a single u16 in reversed IEEE754 format, 8 bytes

fn write_be_i16(&mut self, val: i16) -> Result<(), BitsError>

Writes a single i16 in big-endian order, 2 bytes, MSB first.

fn write_le_i16(&mut self, val: i16) -> Result<(), BitsError>

Writes a single i16 in little-endian order, 2 bytes, LSB first.

fn write_be_i32(&mut self, val: i32) -> Result<(), BitsError>

Writes a single i32 in big-endian order, 4 bytes, MSB first.

fn write_le_i32(&mut self, val: i32) -> Result<(), BitsError>

Writes a single i32 in little-endian order, 4 bytes, LSB first.

fn write_be_i64(&mut self, val: i64) -> Result<(), BitsError>

Writes a single i64 in big-endian order, 8 bytes, MSB first.

fn write_le_i64(&mut self, val: i64) -> Result<(), BitsError>

Writes a single i64 in little-endian order, 8 bytes, LSB first.

fn write_be_i128(&mut self, val: i128) -> Result<(), BitsError>

Writes a single i128 in big-endian order, 16 bytes, MSB first.

fn write_le_i128(&mut self, val: i128) -> Result<(), BitsError>

Writes a single i128 in little-endian order, 16 bytes, LSB first.

fn write_u8_blob(&mut self, val: &[u8]) -> Result<(), BitsError>

Writes a sized blob, a series of bytes preceded by a u8 declaring the size

fn write_be_u16_blob(&mut self, val: &[u8]) -> Result<(), BitsError>

Writes a sized blob, a series of bytes preceded by a u16 declaring the size

fn write_le_u16_blob(&mut self, val: &[u8]) -> Result<(), BitsError>

Writes a sized blob, a series of bytes preceded by a u16 declaring the size

fn write_be_u32_blob(&mut self, val: &[u8]) -> Result<(), BitsError>

Writes a sized blob, a series of bytes preceded by a u32 declaring the size

fn write_le_u32_blob(&mut self, val: &[u8]) -> Result<(), BitsError>

Writes a sized blob, a series of bytes preceded by a u32 declaring the size

fn write_be_u64_blob(&mut self, val: &[u8]) -> Result<(), BitsError>

Writes a sized blob, a series of bytes preceded by a u64 declaring the size

fn write_le_u64_blob(&mut self, val: &[u8]) -> Result<(), BitsError>

Writes a sized blob, a series of bytes preceded by a u64 declaring the size

fn write_all_bytes(&mut self, val: &[u8]) -> Result<(), BitsError>

Writes all the bytes in order

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

Allows the use of core::format_args macro

fn write_some_bytes(&mut self, val: &[u8]) -> usize

Writes some subset of bytes until either the input is exhausted, or the underlying buffer fills up or errors. Returns the total number of bytes written

fn write_str_u32_blob(&mut self, val: &str) -> Result<usize, BitsError>

Writes a specific sized string from the stream, a string prefixed by a 4-byte big-endian length.

fn write_exact(&mut self, val: &[u8], len: usize) -> Result<(), BitsError>

Writes the exact amount of bytes from the input buffer to the output stream Returns an error if the buffer doesn’t have enough values or if the output stream errors.

fn write_all_into_self_from<T>( &mut self, other: &mut T, ) -> Result<u64, BitsError>

where T: Bits,

Copies all data from the other stream into this stream.

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

Flush all bytes out of the cache. Most impl’s won’t need this.

impl<'a, B: MutBits, T: Streamable> Stream<T> for CompressStream<'a, B>

fn write_value(&mut self, value: T) -> Result<usize, Error>

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

fn written_stats(&self) -> String