Struct Error

pub struct Error { /* private fields */ }

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.

Implementations

impl Error

pub 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)
}

pub fn set_location(&mut self, location: ErrorLocation)

Set the location where the error occured.

pub 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.

pub 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.

pub 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, f: &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 Error for Error

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

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

Returns the lower-level source of this error, if any.

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

fn from(error: AddrParseError) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for Error

fn from(error: ErrorKind) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for Error

fn from(error: ParseIntError) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<RecvError> for Error

fn from(_: RecvError) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.