Enum ParameterError 

pub enum ParameterError {
    OutOfRange {
        parameter: String,
        value: String,
        min: String,
        max: String,
        reason: String,
    },
    InvalidValue {
        parameter: String,
        reason: String,
    },
    Missing {
        parameter: String,
    },
    InvalidConfiguration {
        operation: String,
        reason: String,
    },
}

Errors related to invalid parameters, ranges, or configuration values.

This covers validation failures for user-provided parameters to audio processing operations, including range violations and invalid configurations.

Variants

OutOfRange

A parameter value is outside the valid range for the operation.

Fields

parameter: String

Name of the parameter that was out of range.

value: String

The invalid value (as string for display).

min: String

Minimum valid value (as string for display).

max: String

Maximum valid value (as string for display).

reason: String

Additional context about why this range is required.

InvalidValue

A parameter has an invalid value that doesn’t meet operation requirements.

Fields

parameter: String

Name of the parameter with invalid value.

reason: String

Detailed explanation of why the value is invalid.

Missing

Required parameters are missing or empty.

Fields

parameter: String

Name of the missing parameter.

InvalidConfiguration

A configuration object contains conflicting or invalid settings.

Fields

operation: String

The operation or component being configured.

reason: String

Detailed explanation of the configuration problem.

Implementations

impl ParameterError

pub fn out_of_range<P, V, Min, Max, R>( parameter: P, value: V, min: Min, max: Max, reason: R, ) -> Self

where P: ToString, V: ToString, Min: ToString, Max: ToString, R: ToString,

Create a new out-of-range parameter error.

pub fn invalid_value<P, R>(parameter: P, reason: R) -> Self

where P: ToString, R: ToString,

Create a new invalid value parameter error.

Trait Implementations

impl Clone for ParameterError

fn clone(&self) -> ParameterError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterError

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

Formats the value using the given formatter.

impl Display for ParameterError

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

Formats the value using the given formatter.

impl Error for ParameterError

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<&str> for ParameterError

fn from(msg: &str) -> Self

Converts to this type from the input type.

impl From<ParameterError> for AudioSampleError

fn from(source: ParameterError) -> Self

Converts to this type from the input type.

impl From<String> for ParameterError

fn from(msg: String) -> Self

Converts to this type from the input type.