Struct fisher_common::errors::Error

pub struct Error { /* fields omitted */ }

This class represents an error that occured in Fisher.

It contains all the details known about it, and you can either access it programmatically or display the error message to the user, already formatted. It also support automatic conversion from the error types of the libraries Fisher depends on.

Methods

impl Error

fn new(kind: ErrorKind) -> Self

Create a new error. You need to provide the kind of error that occured.

Example

fn my_function() -> Result<()> {
    let error = Error::new(ErrorKind::Dummy);
    Err(error)
}

fn set_location(&mut self, location: ErrorLocation)

Set the location where the error occured.

fn location(&self) -> &ErrorLocation

Get the location where the error occured. You can either access it programmatically or print a pretty version of it to the user.

fn kind(&self) -> &ErrorKind

Get the kind of error occured. You can either access it programmatically or print a pretty version of it to the user.

fn pretty_print(&self)

Show a nicely-formatted version of the error, usually for printing it to the user. The function uses ANSI formatting codes.

if let Err(error) = do_work() {
    error.pretty_print();
}

Trait Implementations

impl Debug for Error

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl StdError for Error

fn description(&self) -> &str

A short description of the error.

fn cause(&self) -> Option<&StdError>

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

impl From<ErrorKind> for Error

fn from(error: ErrorKind) -> Self

Performs the conversion.

impl From<RecvError> for Error

fn from(_: RecvError) -> Self

Performs the conversion.

impl<T> From<SendError<T>> for Error

fn from(_: SendError<T>) -> Self

Performs the conversion.

impl<T> From<PoisonError<T>> for Error

fn from(_: PoisonError<T>) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(error: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(error: Error) -> Self

Performs the conversion.

impl From<AddrParseError> for Error

fn from(error: AddrParseError) -> Self

Performs the conversion.

impl From<ParseIntError> for Error

fn from(error: ParseIntError) -> Self

Performs the conversion.

impl From<Box<StdError + Send + Sync>> for Error

fn from(error: Box<StdError + Send + Sync>) -> Self

Performs the conversion.