Enum ConversionError 

#[non_exhaustive]
pub enum ConversionError {
    AudioConversion {
        value: String,
        source_type: String,
        target_type: String,
        reason: String,
    },
    NumericCast {
        value: String,
        source_type: String,
        target_type: String,
        reason: String,
    },
    UnsupportedConversion {
        source_type: String,
        target_type: String,
    },
}

Errors that occur during type conversion and casting operations.

Purpose

Covers both audio-aware conversions (e.g. i16 ↔ f32 with normalisation) and raw numeric casts between sample types. The distinction between AudioConversion and NumericCast reflects whether the operation understood audio semantics.

Intended Usage

Returned by to_format, to_type, cast_as, and cast_to. Prefer the audio-aware variants (to_format, to_type) over raw casts unless you deliberately need non-normalised bit patterns.

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.

AudioConversion

Failed to convert between audio sample types with audio-aware scaling.

Fields

value: String

The sample value that failed to convert (as string for display).

source_type: String

Source sample type name.

target_type: String

Target sample type name.

reason: String

Detailed reason for the conversion failure.

NumericCast

Failed to perform raw numeric casting between types.

Fields

value: String

The numeric value that failed to cast (as string for display).

source_type: String

Source numeric type name.

target_type: String

Target numeric type name.

reason: String

Detailed reason for the casting failure.

UnsupportedConversion

The conversion operation is not supported between the specified types.

Fields

source_type: String

Source type name.

target_type: String

Target type name.

Implementations

impl ConversionError

pub fn audio_conversion<V, S, T, R>( value: V, source_type: S, target_type: T, reason: R, ) -> Self

where V: ToString, S: ToString, T: ToString, R: ToString,

Creates a ConversionError::AudioConversion error.

Use this when an audio-aware type conversion fails — for example, when a normalised float value cannot be represented in the target integer type.

Arguments

• value — The sample value that failed to convert (converted to string for display).
• source_type — Name of the source sample type (e.g. "i16").
• target_type — Name of the target sample type (e.g. "f32").
• reason — Human-readable explanation of why the conversion failed.

Returns

A ConversionError::AudioConversion variant.

Examples

use audio_samples::{AudioSampleError, ConversionError};

let err = ConversionError::audio_conversion("32768", "i16", "i8", "value out of range");
assert!(matches!(err, ConversionError::AudioConversion { .. }));

// Wraps into the root error type via the From impl.
let audio_err: AudioSampleError = err.into();
assert!(matches!(audio_err, AudioSampleError::Conversion(_)));

pub fn numeric_cast<V, S, T, R>( value: V, source_type: S, target_type: T, reason: R, ) -> Self

where V: ToString, S: ToString, T: ToString, R: ToString,

Creates a ConversionError::NumericCast error.

Use this when a raw numeric cast fails — for example, when casting a large f64 value to u8 would overflow or produce a meaningless bit pattern.

Arguments

• value — The numeric value that failed to cast (converted to string for display).
• source_type — Name of the source numeric type (e.g. "f64").
• target_type — Name of the target numeric type (e.g. "u8").
• reason — Human-readable explanation of why the cast failed.

Returns

A ConversionError::NumericCast variant.

Examples

use audio_samples::ConversionError;

let err = ConversionError::numeric_cast("300.0", "f64", "u8", "value exceeds 255");
assert!(matches!(err, ConversionError::NumericCast { .. }));

Trait Implementations

impl Clone for ConversionError

fn clone(&self) -> ConversionError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConversionError

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

Formats the value using the given formatter.

impl Display for ConversionError

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

Formats the value using the given formatter.

impl Error for ConversionError

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<ConversionError> for AudioSampleError

fn from(source: ConversionError) -> Self

Converts to this type from the input type.