Struct Poison 

pub(crate) struct Poison(pub(crate) Option<ErrorCode>);

Remembers an error that may have left a context in a state zstd considers undefined.

zstd.h says of both ZSTD_compressStream2() and ZSTD_decompressStream() that “if an operation ends with an error, it may leave [the context] in an undefined state”, and that calling them again on such a state is undefined behaviour - the context has to be reset first. So once a streaming operation fails, refuse to run another one until something resets the context, and hand the original error back instead.

Tuple Fields

0: Option<ErrorCode>

Implementations

impl Poison

pub(crate) fn guard(&self) -> Result<(), ErrorCode>

Fails with the error that poisoned the context, if there was one.

pub(crate) fn record(&mut self, res: SafeResult) -> SafeResult

Remembers res if it failed, and passes it through.

pub(crate) fn clear(&mut self)

The context was reset, so it is usable again.

Trait Implementations

impl Clone for Poison

fn clone(&self) -> Poison

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Poison

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

Formats the value using the given formatter.

impl Default for Poison

fn default() -> Poison

Returns the “default value” for a type.