Trait ndless::error::Error

pub trait Error: Debug + Display {
    fn description(&self) -> &str { ... }
    fn cause(&self) -> Option<&dyn Error> { ... }
    fn source(&self) -> Option<&(dyn Error + 'static)> { ... }
}

Error is a trait representing the basic expectations for error values, i.e., values of type E in Result<T, E>. Errors must describe themselves through the Display and Debug traits, and may provide cause chain information:

The source method is generally used when errors cross "abstraction boundaries". If one module must report an error that is caused by an error from a lower-level module, it can allow access to that error via the source method. This makes it possible for the high-level module to provide its own errors while also revealing some of the implementation for debugging via source chains.

Provided methods

fn description(&self) -> &str

This method is soft-deprecated.

Although using it won’t cause compilation warning, new code should use Display instead and new impls can omit it.

To obtain error description as a string, use to_string().

Examples

match "xc".parse::<u32>() {
    Err(e) => {
        // Print `e` itself, not `e.description()`.
        println!("Error: {}", e);
    }
    _ => println!("No error"),
}

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

Examples

use std::error::Error;
use std::fmt;

#[derive(Debug)]
struct SuperError {
    side: SuperErrorSideKick,
}

impl fmt::Display for SuperError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "SuperError is here!")
    }
}

impl Error for SuperError {
    fn description(&self) -> &str {
        "I'm the superhero of errors"
    }

    fn cause(&self) -> Option<&Error> {
        Some(&self.side)
    }
}

#[derive(Debug)]
struct SuperErrorSideKick;

impl fmt::Display for SuperErrorSideKick {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "SuperErrorSideKick is here!")
    }
}

impl Error for SuperErrorSideKick {
    fn description(&self) -> &str {
        "I'm SuperError side kick"
    }
}

fn get_super_error() -> Result<(), SuperError> {
    Err(SuperError { side: SuperErrorSideKick })
}

fn main() {
    match get_super_error() {
        Err(e) => {
            println!("Error: {}", e.description());
            println!("Caused by: {}", e.cause().unwrap());
        }
        _ => println!("No error"),
    }
}

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

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

Examples

use std::error::Error;
use std::fmt;

#[derive(Debug)]
struct SuperError {
    side: SuperErrorSideKick,
}

impl fmt::Display for SuperError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "SuperError is here!")
    }
}

impl Error for SuperError {
    fn description(&self) -> &str {
        "I'm the superhero of errors"
    }

    fn source(&self) -> Option<&(dyn Error + 'static)> {
        Some(&self.side)
    }
}

#[derive(Debug)]
struct SuperErrorSideKick;

impl fmt::Display for SuperErrorSideKick {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "SuperErrorSideKick is here!")
    }
}

impl Error for SuperErrorSideKick {
    fn description(&self) -> &str {
        "I'm SuperError side kick"
    }
}

fn get_super_error() -> Result<(), SuperError> {
    Err(SuperError { side: SuperErrorSideKick })
}

fn main() {
    match get_super_error() {
        Err(e) => {
            println!("Error: {}", e.description());
            println!("Caused by: {}", e.source().unwrap());
        }
        _ => println!("No error"),
    }
}

Loading content...

Methods

impl dyn Error + 'static

pub fn is<T: Error + 'static>(&self) -> bool

Returns true if the boxed type is the same as T

pub fn downcast_ref<T: Error + 'static>(&self) -> Option<&T>

Returns some reference to the boxed value if it is of type T, or None if it isn't.

pub fn downcast_mut<T: Error + 'static>(&mut self) -> Option<&mut T>

Returns some mutable reference to the boxed value if it is of type T, or None if it isn't.

impl dyn Error + Send + 'static

pub fn is<T: Error + 'static>(&self) -> bool

Forwards to the method defined on the type Any.

pub fn downcast_ref<T: Error + 'static>(&self) -> Option<&T>

Forwards to the method defined on the type Any.

pub fn downcast_mut<T: Error + 'static>(&mut self) -> Option<&mut T>

Forwards to the method defined on the type Any.

impl dyn Error + Send + Sync + 'static

pub fn is<T: Error + 'static>(&self) -> bool

Forwards to the method defined on the type Any.

pub fn downcast_ref<T: Error + 'static>(&self) -> Option<&T>

Forwards to the method defined on the type Any.

pub fn downcast_mut<T: Error + 'static>(&mut self) -> Option<&mut T>

Forwards to the method defined on the type Any.

impl dyn Error

pub fn downcast<T: Error + 'static>(
    self: Box<Self>
) -> Result<Box<T>, Box<dyn Error>>

Attempt to downcast the box to a concrete type.

impl dyn Error + Send

pub fn downcast<T: Error + 'static>(
    self: Box<Self>
) -> Result<Box<T>, Box<dyn Error + Send>>

Attempt to downcast the box to a concrete type.

impl dyn Error + Send + Sync

pub fn downcast<T: Error + 'static>(
    self: Box<Self>
) -> Result<Box<T>, Box<Self>>

Attempt to downcast the box to a concrete type.

Implementations on Foreign Types

impl Error for ParseBoolError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for Utf8Error

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for ParseIntError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for TryFromIntError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for TryFromSliceError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for ParseFloatError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for FromUtf8Error

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for FromUtf16Error

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for ParseError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for DecodeUtf16Error

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for Error

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for BorrowError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for BorrowMutError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for CharTryFromError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for ParseCharError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

Loading content...

Implementors

impl Error for ndless::io::Error

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for StripPrefixError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl Error for SystemTimeError

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl<T: Error> Error for Box<T>

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

impl<W: Send + Debug> Error for IntoInnerError<W>

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

Deprecated:

replaced by Error::source, which can support downcasting

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

Loading content...