Struct Error 

pub struct Error {
    pub code: ErrorCode,
    pub message: String,
    pub hint: Option<String>,
}

A failure with its code.

Fields

code: ErrorCode

message: String

hint: Option<String>

What to do about it, when the message doesn’t already say.

Implementations

impl Error

pub fn new(code: impl Into<ErrorCode>, message: impl Into<String>) -> Error

pub fn with_hint(self, hint: impl Into<String>) -> Error

pub fn kind(&self) -> Kind

pub fn or(self, code: Code) -> Error

The step’s own code, unless a more specific one is already set (anything but run-failed, what an uncoded message gets).

pub fn from_plugin(e: &HostError, message: impl Into<String>) -> Error

A plugin’s failure: its own code when it gave one (code without kind counts as internal), else run-failed until the step gives it one. message is what to show.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Error

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

fn from(message: &str) -> Error

Converts to this type from the input type.

impl From<String> for Error

An uncoded message: run-failed, until the step that knows better gives it a code.

fn from(message: String) -> Error

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Error