Struct cramjam::lz4::WriteCompressor

pub struct WriteCompressor<W>
where
    W: Write,
{ /* private fields */ }

The Write-based streaming compressor.

Example

use lzzzz::lz4f::WriteCompressor;
use std::{fs::File, io::prelude::*};

let mut f = File::create("foo.lz4")?;
let mut w = WriteCompressor::new(&mut f, Default::default())?;

w.write_all(b"Hello world!")?;

Implementations

impl<W> WriteCompressor<W>

where W: Write,

pub fn new(writer: W, prefs: Preferences) -> Result<WriteCompressor<W>, Error>

Creates a new WriteCompressor<W>.

pub fn with_dict( writer: W, prefs: Preferences, dict: Dictionary ) -> Result<WriteCompressor<W>, Error>

Creates a new WriteCompressor<W> with a dictionary.

pub fn get_mut(&mut self) -> &mut W

Returns a mutable reference to the writer.

pub fn get_ref(&self) -> &W

Returns a shared reference to the writer.

pub fn into_inner(self) -> W

Returns the ownership of the writer, finishing the stream in the process.

Trait Implementations

impl<W> Debug for WriteCompressor<W>

where W: Write + Debug,

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

Formats the value using the given formatter.

impl<W> Drop for WriteCompressor<W>

where W: Write,

fn drop(&mut self)

Executes the destructor for this type.

impl<W> Write for WriteCompressor<W>

where W: Write,

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

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

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

Flush 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, fmt: 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.