Enum Error 

pub enum Error {
    Configuration(String),
    NotFound(String),
    Serialization(String),
    Unknown(Error),
}

Errors that an automaton can return

When an automaton executes its tasks, things can fail. Automatons might interact with external resources or third-party APIs that are unreliable, the configuration might be wrong, or something totally unexpected might happen. In these situations, automatons can abort their execution and return an [Error].

Example

The implementation of the error type is based on thiserror and anyhow. Unexpected errors can easily be converted to an error by calling .context on the original error.

use std::io::ErrorKind;

use anyhow::Context;
use automatons::Error;

fn connect() -> Result<(), Error> {
    let failure = Err(std::io::Error::new(ErrorKind::TimedOut, "connection timed out"));
    let error = failure.context("failed to connect to API due to connection time out")?;

    Ok(())
}

anyhow: https://crates.io/crates/anyhow thiserror: https://crates.io/crates/thiserror

Variants

Configuration(String)

NotFound(String)

Serialization(String)

Unknown(Error)

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

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

fn from(source: Error) -> Self

Converts to this type from the input type.