Struct Lz4BlockOutputBase

pub struct Lz4BlockOutputBase<'a, W: Write + Sized, C: Compression> { /* private fields */ }

Wrapper around a Write object to compress data.

Use this struct only if you want to provide your own Compression implementation. Otherwise use the alias Lz4BlockOutput.

Implementations

impl<'a, W: Write> Lz4BlockOutputBase<'a, W, Context>

pub fn new(w: &'a mut W) -> Self

Create a new Lz4BlockOutput with the default parameters.

See Self::with_context()

impl<'a, W: Write, C: Compression> Lz4BlockOutputBase<'a, W, C>

pub fn default_block_size() -> usize

Get the default block size: 65536B.

pub fn with_context(w: &'a mut W, c: C, block_size: usize) -> Result<Self>

Create a new Lz4BlockOutputBase with the default checksum implementation which is compatible with the Java’s default implementation, including the missing 4 bits bug.

See Self::with_checksum()

pub fn with_checksum( w: &'a mut W, c: C, block_size: usize, checksum: fn(&[u8]) -> u32, ) -> Result<Self>

Create a new Lz4BlockOutputBase.

The block_size must be between 64 and 33554432 bytes. The checksum must return a u32.

Errors

It will return an error if the block_size is out of range

Trait Implementations

impl<'a, W: Debug + Write + Sized, C: Debug + Compression> Debug for Lz4BlockOutputBase<'a, W, C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, W: Write, C: Compression> Drop for Lz4BlockOutputBase<'a, W, C>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, W: Write, C: Compression> Write for Lz4BlockOutputBase<'a, W, C>

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.