Struct Error

pub struct Error { /* private fields */ }

A struct representing an error in shell operations. It includes the type of the error (ErrorKind) and an optional message.

Implementations

impl Error

pub fn new<T: AsRef<str>>(kind: ErrorKind, message: T) -> Self

Creates a new Error instance with a specified kind and an optional message. If the message is empty, it will use an empty message for the error.

Parameters

• kind: The type of error (e.g., IO, SHELL_NOT_FOUND).
• message: A message describing the error. This can be an empty string.

Returns

A new Error instance with the specified error kind and message.

pub const fn kind(&self) -> &ErrorKind

Retrieves the kind of the error.

Returns

A reference to the ErrorKind variant that represents the type of error.

pub fn message(&self) -> &str

Retrieves the error message, if provided.

Returns

The error message as a string slice. If no message is provided, an empty string is returned.

Trait Implementations

impl Debug for Error

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the Error struct for debugging.

This method provides a detailed output of the error kind and the associated message, which is useful for debugging purposes.

impl Display for Error

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

Formats the Error struct for user-facing display.

If a message is provided, it includes the message along with the error kind. If no message is provided, only the error kind is displayed.

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 a std::io::Error into an Error with the IO error kind and the error message.

This allows for easy conversion from I/O errors (e.g., file or network errors) to our custom Error type.

Parameters

• err: A std::io::Error instance that we want to convert.

Returns

A new Error instance with the IO error kind and the I/O error message.

impl PartialEq for Error

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

Compares two Error instances for equality based on their kind.

Parameters

• self: The first Error instance.
• other: The second Error instance.

Returns

true if both errors have the same kind, false otherwise.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Error