Enum BudgetError 

#[non_exhaustive]
pub enum BudgetError {
    Exceeded {
        diameter: f64,
        bound: f64,
        principal_period: f64,
        ring_down_factor: f64,
    },
}

Failure modes of SpectralBudget. The Display impl is informative enough to surface directly at a user-facing prompt.

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.

Exceeded

The candidate diameter exceeded ring_down_factor · principal_period.

Fields

diameter: f64

The diameter that was rejected.

bound: f64

The admission ceiling at the time of the call.

principal_period: f64

T_1, the principal period of the bounded domain.

ring_down_factor: f64

The multiplier applied to T_1 to compute bound.

Trait Implementations

impl Debug for BudgetError

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

Formats the value using the given formatter.

impl Display for BudgetError

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

Formats the value using the given formatter.

impl Error for BudgetError

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.