Enum EncoderError 

#[non_exhaustive]
pub enum EncoderError {
    NonFiniteRate {
        parameter: &'static str,
    },
    RateOrder,
    InvalidRange {
        parameter: &'static str,
    },
    CountMustBePositive {
        parameter: &'static str,
    },
    NonPositiveOrNonFinite {
        parameter: &'static str,
    },
    NonNegativeFinite {
        parameter: &'static str,
    },
    NumChannelsTooLarge,
    HistoryDepthTooSmall {
        minimum: usize,
    },
    StateLengthMismatch {
        left: &'static str,
        right: &'static str,
    },
    HistoryLengthExceedsDepth {
        channel: usize,
    },
    WindowMustBePositive {
        parameter: &'static str,
    },
}

Stable error type returned by fallible encoder constructors.

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.

NonFiniteRate

A rate parameter must be finite.

Fields

parameter: &'static str

RateOrder

base_rate must not exceed max_rate.

InvalidRange

Numeric range bounds must be finite and strictly increasing.

Fields

parameter: &'static str

CountMustBePositive

Count parameters must be positive.

Fields

parameter: &'static str

NonPositiveOrNonFinite

A threshold/tuning-width style parameter must be finite and positive.

Fields

parameter: &'static str

NonNegativeFinite

A parameter must be finite and non-negative (>= 0).

Fields

parameter: &'static str

NumChannelsTooLarge

Channel/neuron count exceeds the u16 channel-ID range used when emitting spikes.

HistoryDepthTooSmall

Temporal history depth is too small for the encoder window.

Fields

minimum: usize

StateLengthMismatch

A deserialized state vector has inconsistent lengths.

Fields

left: &'static str

right: &'static str

HistoryLengthExceedsDepth

A deserialized history channel contains more samples than allowed by history_depth.

Fields

channel: usize

WindowMustBePositive

Cycle/window parameters must be non-zero.

Fields

parameter: &'static str

Trait Implementations

impl Clone for EncoderError

fn clone(&self) -> EncoderError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncoderError

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

Formats the value using the given formatter.

impl Display for EncoderError

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

Formats the value using the given formatter.

impl Error for EncoderError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<PredictiveEncoderError> for EncoderError

fn from(error: PredictiveEncoderError) -> Self

Converts to this type from the input type.

impl PartialEq for EncoderError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EncoderError