Struct GenericError 

#[non_exhaustive]
pub struct GenericError {
    pub code: Cow<'static, str>,
    pub error: Cow<'static, str>,
    pub msg: Cow<'static, str>,
    pub site: ErrorSite,
    pub help: Option<Cow<'static, str>>,
    pub inner: Vec<ShellError>,
    pub source: Option<ErrorSource>,
}

Generic ShellError.

This is a generic error for all cases where any of the variants of ShellError do not fit and creating new variants is too niche. Usually this should be created using new or new_internal if absolutely no span is available, try however to provide at least some span like call.head inside a Command::run context.

Using with_code, with_help, with_inner can improve the error type making it more useful.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: Cow<'static, str>

The diagnostic code for this error.

Defaults to DEFAULT_CODE. Use with_code to override it.

error: Cow<'static, str>

A short, user-facing title for the error.

msg: Cow<'static, str>

The message describing what went wrong.

site: ErrorSite

The error origin: either a user span or an internal Rust location.

help: Option<Cow<'static, str>>

Optional additional guidance for the user.

inner: Vec<ShellError>

Related errors that provide more context.

source: Option<ErrorSource>

Optional error source.

Implementations

impl GenericError

pub fn new( error: impl Into<Cow<'static, str>>, msg: impl Into<Cow<'static, str>>, span: Span, ) -> Self

Creates a new GenericError tied to user input.

The error is a short title, the msg provides details, and the span points to the user code that triggered the issue.

pub fn new_internal( error: impl Into<Cow<'static, str>>, msg: impl Into<Cow<'static, str>>, ) -> Self

Creates a new GenericError for internal errors without a user span.

This records the Rust call site in the source so the error can be traced even when no user-facing span is available.

pub fn new_internal_with_location( error: impl Into<Cow<'static, str>>, msg: impl Into<Cow<'static, str>>, location: impl Into<Location>, ) -> Self

Creates a new GenericError for internal errors without a user span but a provided Rust location.

Use this in places where a Location is already recorded and just needs to passed on, otherwise prefer new_internal.

pub fn with_code(self, code: impl Into<Cow<'static, str>>) -> Self

Overrides the diagnostic code for this error.

pub fn with_help(self, help: impl Into<Cow<'static, str>>) -> Self

Adds user-facing help text for this error.

pub fn with_inner(self, inner: impl IntoIterator<Item = ShellError>) -> Self

Attaches related errors that provide additional context.

pub fn with_source(self, source: impl StdError + Send + Sync + 'static) -> Self

Attaches error source that can be used to render error chains.

Trait Implementations

impl Clone for GenericError

fn clone(&self) -> GenericError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenericError

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

Formats the value using the given formatter.

impl Diagnostic for GenericError

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

impl Display for GenericError

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

Formats the value using the given formatter.

impl Error for GenericError

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<GenericError> for ShellError

fn from(source: GenericError) -> Self

Converts to this type from the input type.

impl PartialEq for GenericError

fn eq(&self, other: &GenericError) -> 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 GenericError