Struct wast::Error

pub struct Error { /* private fields */ }

A convenience error type to tie together all the detailed errors produced by this crate.

This type can be created from a LexError. This also contains storage for file/text information so a nice error can be rendered along the same lines of rustc’s own error messages (minus the color).

This type is typically suitable for use in public APIs for consumers of this crate.

Implementations

impl Error

pub fn new(span: Span, message: String) -> Error

Creates a new error with the given message which is targeted at the given span

Note that you’ll want to ensure that set_text or set_path is called on the resulting error to improve the rendering of the error message.

pub fn span(&self) -> Span

Return the Span for this error.

pub fn set_text(&mut self, contents: &str)

To provide a more useful error this function can be used to extract relevant textual information about this error into the error itself.

The contents here should be the full text of the original file being parsed, and this will extract a sub-slice as necessary to render in the Display implementation later on.

pub fn set_path(&mut self, path: &Path)

To provide a more useful error this function can be used to set the file name that this error is associated with.

The path here will be stored in this error and later rendered in the Display implementation.

pub fn lex_error(&self) -> Option<&LexError>

Returns the underlying LexError, if any, that describes this error.

pub fn message(&self) -> String

Returns the underlying message, if any, that describes this error.

Trait Implementations

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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