Enum TrainingError 

#[non_exhaustive]
pub enum TrainingError {
    Parameter,
    Samples,
    DictionaryTooSmall,
}

Available on crate feature dict-builder only.

Why a segment trainer or the finalizer refused its input. It rides inside the InvalidInput error returned; TrainingError::of reads it back.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Parameter

A training parameter lies outside its range.

Samples

The samples cannot be trained on: none, too few, or too few or too many bytes.

DictionaryTooSmall

The dictionary asked for is smaller than MIN_TRAINED_DICT_SIZE.

Implementations

impl TrainingError

pub fn of(error: &Error) -> Option<Self>

The cause carried by an error a trainer returned, or None for one it did not raise itself (a failed read, write or allocation).

Examples

use structured_zstd::dictionary::{
    CoverOptions, FinalizeOptions, TrainingError, train_cover_dict,
};

let options = CoverOptions { k: 64, d: 8, ..CoverOptions::default() };
let err = train_cover_dict(&[0; 64], &[64], 100, &options, FinalizeOptions::default())
    .unwrap_err();
assert_eq!(TrainingError::of(&err), Some(TrainingError::DictionaryTooSmall));

Trait Implementations

impl Clone for TrainingError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TrainingError

impl Debug for TrainingError

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

Formats the value using the given formatter.

impl Eq for TrainingError

impl PartialEq for TrainingError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TrainingError