Enum ErrorCause 

#[non_exhaustive]
pub enum ErrorCause {
    CommandSubstError(Errno),
    ArithError(ArithError),
    AssignReadOnly(AssignReadOnlyError),
    UnsetParameter {
        param: Param,
    },
    VacantExpansion(VacantError),
    NonassignableParameter(NonassignableError),
    Interrupted(ExitStatus),
}

Types of errors that may occur in the word expansion.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CommandSubstError(Errno)

System error while performing a command substitution.

ArithError(ArithError)

Error while evaluating an arithmetic expansion.

AssignReadOnly(AssignReadOnlyError)

Assignment to a read-only variable.

UnsetParameter

Expansion of an unset parameter with the nounset option

Fields

param: Param

VacantExpansion(VacantError)

Expansion of an empty value with an error switch

NonassignableParameter(NonassignableError)

Assignment to a nonassignable parameter

Interrupted(ExitStatus)

Expansion interrupted by SIGINT in an interactive shell

This variant is used to propagate a SIGINT interruption that occurred during word expansion (e.g., in a command substitution or pathname expansion). The exit status is derived from the SIGINT signal.

Implementations

impl ErrorCause

pub fn message(&self) -> &str

Returns an error message describing the error.

pub fn label(&self) -> Cow<'_, str>

Returns a label for annotating the error location.

pub fn related_location(&self) -> Option<(&Location, &'static str)>

Returns a location related with the error cause and a message describing the location.

pub fn footer(&self) -> Option<&'static str>

Returns a footer message for the error.

Trait Implementations

impl Clone for ErrorCause

fn clone(&self) -> ErrorCause

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCause

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

Formats the value using the given formatter.

impl Display for ErrorCause

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

Formats the value using the given formatter.

impl Eq for ErrorCause

impl Error for ErrorCause

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<ArithError> for ErrorCause

fn from(source: ArithError) -> Self

Converts to this type from the input type.

impl From<AssignReadOnlyError> for ErrorCause

fn from(source: AssignReadOnlyError) -> Self

Converts to this type from the input type.

impl From<ErrorCause> for ErrorCause

fn from(source: ErrorCause) -> Self

Converts to this type from the input type.

impl From<NonassignableError> for ErrorCause

fn from(source: NonassignableError) -> Self

Converts to this type from the input type.

impl From<VacantError> for ErrorCause

fn from(source: VacantError) -> Self

Converts to this type from the input type.

impl PartialEq for ErrorCause

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

Tests for self and other values to be equal, and is used by ==.

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 StructuralPartialEq for ErrorCause