Struct ZstdSeekTable 

pub struct ZstdSeekTable { /* private fields */ }

A table containing offsets and sizes for the frames within a zstd stream, such as from the zstd seekable format.

Reading

If a zstd stream uses the zstd seekable format, you can parse its seek table using the read_seek_table function (or one of its async variants).

Usage

ZstdReader can use a seek table to speed up seeks through the stream. To do so, pass the stream’s seek table using the .with_seek_table() builder option. When using AsyncZstdReader, you need to use both the .with_seek_table() builder option and the .seekable() wrapper method.

Writing

ZstdWriter can write a seek table by enabling the .with_seek_table() builder option. The same applies when using AsyncZstdWriter.

Implementations

impl ZstdSeekTable

pub fn num_frames(&self) -> usize

Returns the total number of zstd frames in the table.

pub fn frames(&self) -> impl Iterator<Item = ZstdFrame> + '_

Returns an iterator over each of the frames in the table. Frames are ordered from the start of the zstd stream to the end.

Trait Implementations

impl Debug for ZstdSeekTable

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

Formats the value using the given formatter.