Struct cramjam::lz4::Decompressor

pub struct Decompressor<'a, R>
where
    R: Read,
{ /* private fields */ }

The Read-based streaming decompressor.

Example

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

let mut f = File::open("foo.lz4")?;
let mut r = ReadDecompressor::new(&mut f)?;

let mut buf = Vec::new();
r.read_to_end(&mut buf)?;

Implementations

impl<'a, R> ReadDecompressor<'a, R>

where R: Read,

pub fn new(reader: R) -> Result<ReadDecompressor<'a, R>, Error>

Creates a new ReadDecompressor<R>.

pub fn set_dict<D>(&mut self, dict: D)

where D: Into<Cow<'a, [u8]>>,

Sets the dictionary.

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

Reads the frame header and returns FrameInfo.

Calling this function before any Read operations does not consume the frame body.

pub fn into_inner(self) -> R

Returns ownership of the reader.

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

Returns a mutable reference to the reader.

pub fn get_ref(&self) -> &R

Returns a shared reference to the reader.

Trait Implementations

impl<R> Debug for ReadDecompressor<'_, R>

where R: Read + Debug,

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

Formats the value using the given formatter.

impl<R> Read for ReadDecompressor<'_, R>

where R: Read,

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.