Enum gilrs::ff::DistanceModelError

#[non_exhaustive]
pub enum DistanceModelError {
    InvalidReferenceDistance,
    InvalidRolloffFactor,
    InvalidMaxDistance,
    InvalidModelParameter,
}

Error that can be returned when passing DistanceModel with invalid value.

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.

InvalidReferenceDistance

Reference distance is < 0.

InvalidRolloffFactor

Rolloff factor is < 0.

InvalidMaxDistance

Max distance is < 0.

InvalidModelParameter

Possible divide by zero

Trait Implementations

impl Clone for DistanceModelError

fn clone(&self) -> DistanceModelError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DistanceModelError

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

Formats the value using the given formatter.

impl Display for DistanceModelError

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

Formats the value using the given formatter.

impl Error for DistanceModelError

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

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<DistanceModelError> for Error

fn from(f: DistanceModelError) -> Self

Converts to this type from the input type.

impl PartialEq for DistanceModelError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DistanceModelError

impl Eq for DistanceModelError

impl StructuralPartialEq for DistanceModelError