Struct Error 

pub struct Error { /* private fields */ }

Unified error type for this crate. Contains just a kind for now, but will be extended later with additional context.

Implementations

impl Error

pub const fn into_fatal(self) -> Self

Marks this error as fatal.

pub const fn is_fatal(&self) -> bool

Returns whether or not this error is fatal.

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

Returns a reference to the error kind.

pub fn as_io_error(&self) -> Option<&Error>

Try to extract a reference to the underlying std::io::Error, if any.

pub fn to_control_flow( &self, shell: &Shell<impl ShellExtensions>, ) -> ExecutionControlFlow

Converts this error into the appropriate control flow based on the shell’s current state. This centralizes the logic for determining how fatal errors should affect execution flow.

Arguments

• shell - The shell instance, used to check interactive mode and script call stack.

pub fn into_result(self, shell: &Shell<impl ShellExtensions>) -> ExecutionResult

Converts this error into an execution result for the shell.

Arguments

• shell - The shell instance, used to determine control flow.

Trait Implementations

impl BuiltinError for Error

fn as_io_error(&self) -> Option<&Error>

Try to extract a reference to the underlying std::io::Error, if any. Implementations should return None if there is no inner I/O error. They should not attempt to synthesize an I/O error if one does not naturally exist.

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 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 ExecutionExitCode

fn from(error: &Error) -> Self

Converts to this type from the input type.

impl<T> From<T> for Error

where ErrorKind: From<T>,

fn from(convertible_to_kind: T) -> Self

Converts to this type from the input type.