Struct Error 

pub struct Error { /* private fields */ }

The fundamental error type used by this library.

An error type which encapsulates information about whether an error is the result of something the user did, or a system failure outside their control. These errors include a description of what occurred, advice on how to proceed and references to the causal chain which led to this failure.

Examples

use human_errors;

let err = human_errors::user(
  "We could not open the config file you provided.",
  &["Make sure that the file exists and is readable by the application."],
);

// Prints the error and any advice for the user.
println!("{}", err)

Implementations

impl Error

pub fn new<E: Into<Box<dyn Error + Send + Sync>>>( error: E, kind: Kind, advice: &'static [&'static str], ) -> Self

Constructs a new Error.

Examples

use human_errors;
let err = human_errors::Error::new(
    "Low-level IO error details",
    human_errors::Kind::System,
    &["Try restarting the application", "If the problem persists, contact support"]
);

pub fn is(&self, kind: Kind) -> bool

Checks if this error is of a specific kind.

Returns true if this error matches the provided Kind, otherwise false.

Examples

use human_errors;

let err = human_errors::user(
  "We could not open the config file you provided.",
  &["Make sure that the file exists and is readable by the application."],
);

// Prints "is_user?: true"
println!("is_user?: {}", err.is(human_errors::Kind::User));

pub fn description(&self) -> String

Gets the description message from this error.

Gets the description which was provided as the first argument when constructing this error.

Examples

use human_errors;

let err = human_errors::user(
  "We could not open the config file you provided.",
  &["Make sure that the file exists and is readable by the application."],
);

// Prints: "We could not open the config file you provided."
println!("{}", err.description())

pub fn advice(&self) -> Vec<&'static str>

Gets the advice associated with this error and its causes.

Gathers all advice from this error and any causal errors it wraps, returning a deduplicated list of suggestions for how a user should deal with this error.

Examples

use human_errors;

let err = human_errors::wrap_user(
  human_errors::user(
    "We could not find a file at /home/user/.config/demo.yml",
    &["Make sure that the file exists and is readable by the application."]
  ),
  "We could not open the config file you provided.",
  &["Make sure that you've specified a valid config file with the --config option."],
);

// Prints:
// - Make sure that the file exists and is readable by the application.
// - Make sure that you've specified a valid config file with the --config option.
for tip in err.advice() {
    println!("- {}", tip);
}

pub fn message(&self) -> String

Gets the formatted error and its advice.

Generates a string containing the description of the error and any causes, as well as a list of suggestions for how a user should deal with this error. The “deepest” error’s advice is presented first, with successively higher errors appearing lower in the list. This is done because the most specific error is the one most likely to have the best advice on how to resolve the problem.

Examples

use human_errors;

let err = human_errors::wrap_user(
  human_errors::user(
    "We could not find a file at /home/user/.config/demo.yml",
    &["Make sure that the file exists and is readable by the application."]
  ),
  "We could not open the config file you provided.",
  &["Make sure that you've specified a valid config file with the --config option."],
);

// Prints a message like the following:
// We could not open the config file you provided. (User error)
//
// This was caused by:
// We could not find a file at /home/user/.config/demo.yml
//
// To try and fix this, you can:
//  - Make sure that the file exists and is readable by the application.
//  - Make sure that you've specified a valid config file with the --config option.
println!("{}", err.message());

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 source(&self) -> Option<&(dyn Error + 'static)>

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

fn description(&self) -> &str

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

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

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

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

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.