Enum AUTDDriverError

#[non_exhaustive]
pub enum AUTDDriverError {
    ModulationSizeOutOfRange(usize),
    InvalidSilencerCompletionTime(Duration),
    SilencerCompletionTimeOutOfRange(Duration),
    UnkownKey(String),
    KeyIsAlreadyUsed(String),
    UnusedKey(String),
    SamplingDivisionInvalid(u16),
    SamplingFreqInvalid(Freq<u32>),
    SamplingFreqInvalidF(Freq<f32>),
    SamplingPeriodInvalid(Duration),
    SamplingFreqOutOfRange(Freq<u32>, Freq<u32>, Freq<u32>),
    SamplingFreqOutOfRangeF(Freq<f32>, Freq<f32>, Freq<f32>),
    SamplingPeriodOutOfRange(Duration, Duration, Duration),
    STMPeriodInvalid(usize, Duration),
    FociSTMPointSizeOutOfRange(usize),
    FociSTMNumFociOutOfRange(usize),
    FociSTMPointOutOfRange(f32, f32, f32),
    GainSTMSizeOutOfRange(usize),
    GainSTMModeNotSupported(GainSTMMode),
    ModulationError(String),
    GainError(String),
    LinkError(String),
    LinkClosed,
    ConfirmResponseFailed,
    SendDataFailed,
    InvalidDateTime,
    NotSupportedTag,
    InvalidSegmentTransition,
    InvalidTransitionMode,
    MissTransitionTime,
    InvalidSilencerSettings,
}

A interface for error handling in autd3-driver.

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.

ModulationSizeOutOfRange(usize)

Modulation buffer size is out of range.

InvalidSilencerCompletionTime(Duration)

Invalid silencer completion time.

SilencerCompletionTimeOutOfRange(Duration)

Silencer completion time is out of range.

UnkownKey(String)

Unknown group key.

KeyIsAlreadyUsed(String)

Key is already used.

UnusedKey(String)

Unused group key.

SamplingDivisionInvalid(u16)

Invalid sampling division.

SamplingFreqInvalid(Freq<u32>)

Invalid sampling frequency.

SamplingFreqInvalidF(Freq<f32>)

Invalid sampling frequency.

SamplingPeriodInvalid(Duration)

Invalid sampling period.

SamplingFreqOutOfRange(Freq<u32>, Freq<u32>, Freq<u32>)

Sampling frequency is out of range.

SamplingFreqOutOfRangeF(Freq<f32>, Freq<f32>, Freq<f32>)

Sampling frequency is out of range.

SamplingPeriodOutOfRange(Duration, Duration, Duration)

Sampling period is out of range.

STMPeriodInvalid(usize, Duration)

Invalid STM period.

FociSTMPointSizeOutOfRange(usize)

FociSTM buffer size is out of range.

FociSTMNumFociOutOfRange(usize)

Number of foci is out of range.

FociSTMPointOutOfRange(f32, f32, f32)

FociSTM point is out of range.

GainSTMSizeOutOfRange(usize)

GainSTM buffer size is out of range.

GainSTMModeNotSupported(GainSTMMode)

GainSTM mode is not supported.

ModulationError(String)

Error in the modulation.

GainError(String)

Error in the gain.

LinkError(String)

Error in the Link.

LinkClosed

Link is closed.

ConfirmResponseFailed

Failed to confirm the response from the device.

SendDataFailed

Failed to send data.

InvalidDateTime

Invalid date time.

NotSupportedTag

Not supported tag.

Occurs when the software is not compatible with the firmware.

InvalidSegmentTransition

Invalid segment transition.

InvalidTransitionMode

Invalid segment transition mode.

MissTransitionTime

Miss transition time.

InvalidSilencerSettings

Silencer cannot complete phase/intensity completion in the specified sampling period.

Trait Implementations

impl Clone for AUTDDriverError

fn clone(&self) -> AUTDDriverError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AUTDDriverError

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

Formats the value using the given formatter.

impl Display for AUTDDriverError

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

Formats the value using the given formatter.

impl Error for AUTDDriverError

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 AUTDDriverError

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AUTDDriverError