Enum raestro::Error

pub enum Error {
    Uninitialized,
    InvalidValue(u16),
    FaultyRead {
        actual_count: usize,
    },
    FaultyWrite {
        actual_count: usize,
        expected_count: usize,
    },
    Io(IoError),
}

The custom raestro error type.

Contains all custom error variants, as well as a wrapper for the std::io::Error enum. All rppal errors are unwrapped and converted into their underlying std::io::Error instances, and then wrapped in the Error::Io variant.

Variants

Uninitialized

The maestro instance is in an uninitialized state.

Consider calling Maestro::start with a corresponding baudrate to transition this instance into the initialized state.

InvalidValue(u16)

An invalid value was passed in as a parameter.

Mainly used when an incorrect microsecond target was passed into set_target.

FaultyRead

Occurs when the expected number of bytes received from the Maestro do not equal RESPONSE_SIZE.

FaultyRead.0 is the number of bytes actually read.

Fields of FaultyRead

actual_count: usize

FaultyWrite

Occurs when the expected number of bytes written to the Maestro were incorrect (according to the protocol being sent).

Fields of FaultyWrite

actual_count: usizeexpected_count: usize

Io(IoError)

Remaining IO errors as encountered by the rppal library, or something else.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formatting for raestro::Error.

impl Error for Error

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<Error> for Error

fn from(io_error: IoError) -> Self

Wraps a std::io::Error in the raestro::Error::Io variant.

impl From<Error> for Error

fn from(uart_error: UartError) -> Self

Used to convert from an rppal::uart::Error type into the raestro::Error.