Skip to main content

Decoder

Struct Decoder 

Source
pub struct Decoder { /* private fields */ }
Expand description

Reusable OpenZL decoder with scratch buffers and codec state.

Implementations§

Source§

impl Decoder

Source

pub fn new() -> Self

Creates a decoder with Options::default.

Source

pub fn with_options(options: Options) -> Self

Creates a decoder with explicit options.

Source

pub fn options(&self) -> Options

Source

pub fn limits(&self) -> Limits

Source

pub fn load_dictionary_bundle(&mut self, bytes: &[u8]) -> Result<()>

Loads an OpenZL dictionary bundle for later dictionary-backed decode.

Currently only zstd dictionary materialization is implemented.

Source

pub fn load_fat_bundle(&mut self, bytes: &[u8]) -> Result<()>

Loads a fat OpenZL dictionary bundle for later dictionary-backed decode.

Prefer Decoder::load_dictionary_bundle for new code.

Source

pub fn clear_dictionary_bundles(&mut self)

Clears all loaded dictionary bundles.

Source

pub fn decode_into(&mut self, input: &[u8], dst: &mut Vec<u8>) -> Result<usize>

Decodes one OpenZL frame and appends the decoded bytes to dst.

Returns the number of bytes appended. On error, dst is restored to its original length.

Source

pub fn decode(&mut self, input: &[u8]) -> Result<Vec<u8>>

Decodes one OpenZL frame into a new Vec.

Source

pub fn inspect(&self, input: &[u8]) -> Result<FrameInfo>

Parses and validates frame metadata without executing decode nodes.

Trait Implementations§

Source§

impl Default for Decoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.