Struct zstd_seekable::Seekable

pub struct Seekable<R> { /* fields omitted */ }

The type of decompressors.

Implementations

impl<R: Read + Seek> Seekable<R>

pub fn init(source: R, size: Option<usize>) -> Result<Self, Error>

pub fn decompress_frame(
    &mut self,
    dest: &mut [u8],
    index: usize
) -> Result<usize, Error>

Decompress a single frame. This method internally calls decompress, and dest must be exactly the size of the uncompressed frame.

pub fn decompress(
    &mut self,
    out: &mut [u8],
    offset: u64
) -> Result<usize, Error>

Decompress starting from an offset. The length of out must be at least the size of the decompressed output.

This function finds the correct frame to start with, and takes care of decompressing multiple frames in a row.

impl<R> Seekable<R>

pub fn get_num_frames(&self) -> usize

Number of frames in the message.

pub fn get_frame_compressed_offset(
    &self,
    frame_index: usize
) -> Result<u64, Error>

Offset of the frame in the compressed data.

pub fn get_frame_compressed_size(
    &self,
    frame_index: usize
) -> Result<u64, Error>

Size of the frame in the compressed data.

pub fn get_frame_decompressed_offset(
    &self,
    frame_index: usize
) -> Result<u64, Error>

Offset of the frame in the decompressed data.

pub fn get_frame_decompressed_size(
    &self,
    frame_index: usize
) -> Result<u64, Error>

Size of the frame in the decompressed data.

pub fn seekable_offset_to_frame_index(&self, offset: u64) -> usize

Perform a binary search to find the frame containing the offset.

impl<'a> Seekable<Cursor<&'a [u8]>>

pub fn init_buf(input: &'a [u8]) -> Result<Self, Error>

Initialise a decompressor with an input buffer.

impl Seekable<File>

pub fn init_file(name: &str) -> Result<Self, Error>

Initialise a decompressor with a file. This method opens the file, and dropping the resulting Seekable closes the file.

Trait Implementations

impl<R> Drop for Seekable<R>

fn drop(&mut self)

Executes the destructor for this type.

impl<R> Send for Seekable<R>