Struct ShellError

pub struct ShellError {
    pub error: ProximateShellError,
    pub notes: Vec<String>,
}

A ShellError is a proximate error and a possible cause, which could have its own cause, creating a cause chain.

Fields

error: ProximateShellError

notes: Vec<String>

Implementations

impl ShellError

pub fn type_error( expected: impl Into<String>, actual: Spanned<impl Into<String>>, ) -> ShellError

An error that describes a mismatch between the given type and the expected type

pub fn missing_property( subpath: Spanned<impl Into<String>>, expr: Spanned<impl Into<String>>, ) -> ShellError

pub fn missing_value( span: impl Into<Option<Span>>, reason: impl Into<String>, ) -> ShellError

pub fn invalid_integer_index( subpath: Spanned<impl Into<String>>, integer: impl Into<Span>, ) -> ShellError

pub fn untagged_runtime_error(error: impl Into<String>) -> ShellError

pub fn unexpected_eof( expected: impl Into<String>, span: impl Into<Span>, ) -> ShellError

pub fn range_error( expected: impl Into<ExpectedRange>, actual: &Spanned<impl Debug>, operation: impl Into<String>, ) -> ShellError

pub fn syntax_error(problem: Spanned<impl Into<String>>) -> ShellError

pub fn coerce_error( left: Spanned<impl Into<String>>, right: Spanned<impl Into<String>>, ) -> ShellError

pub fn argument_error( command: Spanned<impl Into<String>>, kind: ArgumentError, ) -> ShellError

pub fn diagnostic(diagnostic: Diagnostic<usize>) -> ShellError

pub fn into_diagnostic(self) -> Diagnostic<usize>

pub fn labeled_error( msg: impl Into<String>, label: impl Into<String>, span: impl Into<Span>, ) -> ShellError

pub fn labeled_error_with_secondary( msg: impl Into<String>, primary_label: impl Into<String>, primary_span: impl Into<Span>, secondary_label: impl Into<String>, secondary_span: impl Into<Span>, ) -> ShellError

pub fn unimplemented(title: impl Into<String>) -> ShellError

pub fn unexpected(title: impl Into<String>) -> ShellError

pub fn is_unimplemented(&self) -> bool

Trait Implementations

impl Clone for ShellError

fn clone(&self) -> ShellError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShellError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShellError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ShellError

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

Formats the value using the given formatter.

impl Error for ShellError

fn custom<T>(msg: T) -> Self

where T: Display,

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl Error for ShellError

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<Box<dyn Error>> for ShellError

fn from(input: Box<dyn Error>) -> ShellError

Converts to this type from the input type.

impl From<Box<dyn Error + Send + Sync>> for ShellError

fn from(input: Box<dyn Error + Send + Sync>) -> ShellError

Converts to this type from the input type.

impl From<Error> for ShellError

fn from(input: Error) -> ShellError

Converts to this type from the input type.

impl From<Error> for ShellError

fn from(input: Error) -> ShellError

Converts to this type from the input type.

impl From<Error> for ShellError

fn from(input: Error) -> ShellError

Converts to this type from the input type.

impl From<Error> for ShellError

fn from(input: Error) -> ShellError

Converts to this type from the input type.

impl From<FromUtf8Error> for ShellError

fn from(input: FromUtf8Error) -> ShellError

Converts to this type from the input type.

impl From<ParseError> for ShellError

Convert a ParseError into a ShellError

fn from(error: ParseError) -> ShellError

Converts to this type from the input type.

impl From<PatternError> for ShellError

fn from(input: PatternError) -> ShellError

Converts to this type from the input type.

impl From<Utf8Error> for ShellError

fn from(input: Utf8Error) -> ShellError

Converts to this type from the input type.

impl HasFallibleSpan for ShellError

fn maybe_span(&self) -> Option<Span>

impl Hash for ShellError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ShellError

fn cmp(&self, other: &ShellError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ShellError

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

fn partial_cmp(&self, other: &ShellError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PrettyDebug for ShellError

PrettyDebug is for internal debugging. For user-facing debugging, into_diagnostic is used, which prints an error, highlighting spans.

fn pretty(&self) -> DebugDocBuilder

fn to_doc(&self) -> DebugDoc

fn pretty_doc( &self, ) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

fn pretty_builder(&self) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>

fn display(&self) -> String

A convenience method that prints out the document without colors in 70 columns. Generally, you should use plain_string or colored_string if possible, but display() can be useful for trace lines and things like that, where you don’t have control over the terminal.

fn plain_string(&self, width: usize) -> String

fn colored_string(&self, width: usize) -> String

impl Serialize for ShellError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ShellError

impl StructuralPartialEq for ShellError