Struct ShellParseError 

pub struct ShellParseError {
    pub message: String,
    pub span: Span,
    pub suggestion: Option<String>,
}

Fields

message: String

span: Span

suggestion: Option<String>

Implementations

impl ShellParseError

pub fn render(&self, source: &str) -> String

Renders the diagnostic against the source the span points into:

error: background jobs (`&`) are not supported
  │ watch & build
  │       ^
  = help: the engine already parallelizes beams; ...

Multi-line sources (a run string with embedded newlines) excerpt only the line containing the span start.

The caret is positioned by counting characters, not bytes: spans are byte offsets, and padding with one space per byte would push the underline right by one column for every accented character ahead of it on the line. One space per character is right for everything a beam command realistically contains; a double-width character (CJK, an emoji) would still shift it, which would need display-width measurement rather than a count.

Trait Implementations

impl Clone for ShellParseError

fn clone(&self) -> ShellParseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellParseError

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

Formats the value using the given formatter.

impl Display for ShellParseError

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

Formats the value using the given formatter.

impl Error for ShellParseError

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 PartialEq for ShellParseError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ShellParseError