Enum SpectralResidualError 

#[non_exhaustive]
pub enum SpectralResidualError {
    OptionOutOfRange {
        option: &'static str,
        requirement: &'static str,
        got: f64,
        min: Option<f64>,
        exclusive_min: Option<f64>,
        max: Option<f64>,
        exclusive_max: Option<f64>,
    },
    TooFewObservations {
        needed: usize,
        got: usize,
    },
    ValueNotFinite {
        index: usize,
    },
}

Why a SpectralResidual run was refused.

One condition, not the rulebook. A consumer has to tell its user which setting to change, and a refusal that lists every rule leaves it re-validating the options the crate already checks – which is how the same rules end up written twice, in two places that can drift.

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.

OptionOutOfRange

An option is outside its domain.

Each end of the domain is given once: min when the lower bound is inclusive, exclusive_min when it is exclusive, neither when there is none (likewise max / exclusive_max).

Fields

option: &'static str

The option’s name, spelled as the builder and the wire formats spell it (threshold, sensitivity, …).

requirement: &'static str

What that option has to satisfy, for a message a consumer can show.

got: f64

The value given (a count option’s value as a float).

min: Option<f64>

Inclusive lower bound.

exclusive_min: Option<f64>

Exclusive lower bound.

max: Option<f64>

Inclusive upper bound.

exclusive_max: Option<f64>

Exclusive upper bound.

TooFewObservations

Fewer observations than the transform is applied to at once.

Fields

needed: usize

MIN_OBSERVATIONS.

got: usize

How many were given.

ValueNotFinite

The series holds a NaN or an infinity.

Fields

index: usize

Position of the first such value.

Trait Implementations

impl Clone for SpectralResidualError

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 SpectralResidualError

impl Debug for SpectralResidualError

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

Formats the value using the given formatter.

impl Display for SpectralResidualError

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

Formats the value using the given formatter.

impl Error for SpectralResidualError

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 PartialEq for SpectralResidualError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SpectralResidualError