Enum ResetDirective 

pub enum ResetDirective {
    SessionOnly,
    Parameters,
    SessionAndParameters,
}

What kind of context reset should be applied.

Variants

SessionOnly

Only the session will be reset.

All parameters will be preserved (including the dictionary). But any frame being processed will be dropped.

It can be useful to start re-using a context after an error or when an ongoing compression is no longer needed.

Parameters

Only reset parameters (including dictionary or referenced prefix).

All parameters will be reset to default values.

This can only be done between sessions - no compression or decompression must be ongoing.

SessionAndParameters

Reset both the session and parameters.

The result is similar to a newly created context.

Implementations

impl ResetDirective

pub(crate) fn resets_session(self) -> bool

Does this drop a session in progress?

Only a session reset brings a context back from the undefined state an error can leave it in - Parameters alone is refused while a session is open.

pub(crate) fn as_sys(self) -> ZSTD_ResetDirective

Trait Implementations

impl Clone for ResetDirective

fn clone(&self) -> ResetDirective

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResetDirective

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

Formats the value using the given formatter.

impl PartialEq for ResetDirective

fn eq(&self, other: &ResetDirective) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ResetDirective

impl Eq for ResetDirective

impl StructuralPartialEq for ResetDirective