Struct lair_keystore::dependencies::one_err::OneErr

[−]

pub struct OneErr(_);

Expand description

OneErr to rule them all. See crate docs for usage.

Implementations

impl OneErr

pub fn new<K>(kind: K) -> OneErr where
K: Display,

Create a new OneErr error instance.

pub fn with_message<K, M>(kind: K, message: M) -> OneErr where
K: Display,
M: Display,

Create a new OneErr error instance with a message.

pub fn io_kind(&self) -> ErrorKind

Get the std::io::ErrorKind associated with this instance.

pub fn errno(&self) -> ErrNo

Get the ErrNo associated with this instance, if any.

pub fn str_kind(&self) -> &str

Get the &str kind associated with this instance. This can be more descriptive where io_kind() or errno() might return ‘Other’.

pub fn as_io(&self) -> &Error

Get a reference to the inner std::io::Error of this instance.

pub fn set_field<K, T>(&mut self, name: &K, t: T) -> &mut OneErr where
K: Display + ?Sized,
T: Into<Value>,

Set an additional data field on this OneErr. Will panic on reserved names: “error”, “os”, “source”, “backtrace”, “message”.

pub fn get_message(&self) -> Option<&str>

Get the message associated with this instance, or empty string.

pub fn get_field<'lt, R, V>(&'lt self, name: R) -> Option<V> where
R: AsRef<str>,
Option<V>: From<&'lt Value>,

Get the value of an additional field associated with this error, or None if no such field exists. Valid output types: &str, bool, i64, u64, and f64.

Methods from Deref<Target = Error>

1.0.0 · source

pub fn raw_os_error(&self) -> Option<i32>

Returns the OS error that this error represents (if any).

If this Error was constructed via last_os_error or from_raw_os_error, then this function will return Some, otherwise it will return None.

Examples

use std::io::{Error, ErrorKind};

fn print_os_error(err: &Error) {
    if let Some(raw_os_err) = err.raw_os_error() {
        println!("raw OS error: {raw_os_err:?}");
    } else {
        println!("Not an OS error");
    }
}

fn main() {
    // Will print "raw OS error: ...".
    print_os_error(&Error::last_os_error());
    // Will print "Not an OS error".
    print_os_error(&Error::new(ErrorKind::Other, "oh no!"));
}

1.3.0 · source

pub fn get_ref(&self) -> Option<&(dyn Error + Sync + Send + 'static)>

Returns a reference to the inner error wrapped by this error (if any).

If this Error was constructed via new then this function will return Some, otherwise it will return None.

Examples

use std::io::{Error, ErrorKind};

fn print_error(err: &Error) {
    if let Some(inner_err) = err.get_ref() {
        println!("Inner error: {inner_err:?}");
    } else {
        println!("No inner error");
    }
}

fn main() {
    // Will print "No inner error".
    print_error(&Error::last_os_error());
    // Will print "Inner error: ...".
    print_error(&Error::new(ErrorKind::Other, "oh no!"));
}

1.0.0 · source

pub fn kind(&self) -> ErrorKind

Returns the corresponding ErrorKind for this error.

Examples

use std::io::{Error, ErrorKind};

fn print_error(err: Error) {
    println!("{:?}", err.kind());
}

fn main() {
    // Will print "Uncategorized".
    print_error(Error::last_os_error());
    // Will print "AddrInUse".
    print_error(Error::new(ErrorKind::AddrInUse, "oh no!"));
}