Struct Err

Source

pub struct Err { /* private fields */ }

Expand description

The error type used within the Sabi framework.

It holds a value of any type that represents the reason for the error. By the reason, it is possible to identify the error or retrieve the detailed information about the error.

Implementations§

Source §

impl Err

Source

pub fn new<R>(reason: R) -> Self
where R: Debug + Send + Sync + 'static,

Creates a new error with the value reprenents the reason.

use sabi::Err;

#[derive(Debug)]
enum Reasons {
    IllegalState { state: String },
}

let err = Err::new(Reasons::IllegalState { state: "bad state".to_string() });

Source

pub fn with_source<R, E>(reason: R, source: E) -> Self
where R: Debug + Send + Sync + 'static, E: Error + Send + Sync + 'static,

Creates a new error with the value reprenents the reason and the source error that causes this error.

use sabi::Err;
use std::io;

#[derive(Debug)]
enum Reasons {
    FailToDoSomething,
}

let io_error = io::Error::other("oh no!");

let err = Err::with_source(Reasons::FailToDoSomething, io_error);

Source

pub fn is_reason<R>(&self) -> bool
where R: Debug + Send + Sync + 'static,

Checks if R is the type of the reason held by this error object.

use sabi::Err;

#[derive(Debug)]
enum Reasons {
    IllegalState { state: String },
}

let err = Err::new(Reasons::IllegalState { state: "bad state".to_string() });
assert!(err.is_reason::<Reasons>());
assert!(err.is_reason::<String>() == false);

Source

pub fn reason<R>(&self) -> Result<&R, &Self>
where R: Debug + Send + Sync + 'static,

Gets the reason value if the type of the reason is R.

use sabi::Err;

#[derive(Debug)]
enum Reasons {
    IllegalState { state: String },
}

let err = Err::new(Reasons::IllegalState { state: "bad state".to_string() });
match err.reason::<Reasons>() {
  Ok(r) => match r {
    Reasons::IllegalState { state } => println!("state = {state}"),
    _ => { /* ... */ }
  }
  Err(err) => match err.reason::<String>() {
     Ok(s) => println!("string reason = {s}"),
     Err(_err) => { /* ... */ }
  }
}

Source

pub fn match_reason<R>(&self, func: fn(&R)) -> &Self
where R: Debug + Send + Sync + 'static,

Checks the type of the reason held by this object, and if it matches, executes the provided function.

use sabi::Err;

#[derive(Debug)]
enum Reasons {
    IllegalState { state: String },
}

let err = Err::new(Reasons::IllegalState { state: "bad state".to_string() });
err.match_reason::<Reasons>(|r| match r {
    Reasons::IllegalState { state } => println!("state = {state}"),
    _ => { /* ... */ }
})
.match_reason::<String>(|s| {
    println!("string reason = {s}");
});