Struct ScanError

pub struct ScanError {
    pub at: ScanErrorAt,
    pub kind: ScanErrorKind,
    /* private fields */
}

Represents an error that occurred during scanning.

Depending on what happened, it could represent an actual scanning failure, a problem with the pattern, an underlying IO failure, or something else entirely.

Fields

at: ScanErrorAt

The rough cursor position at which this error occurred. This will typically be the position the input cursor was at when it began trying to scan a particular literal or value.

kind: ScanErrorKind

The kind of error that occurred.

Implementations

impl ScanError

pub fn new(at: usize, kind: ScanErrorKind) -> Self

Construct a new ScanError.

pub fn expected_end() -> Self

Shorthand for constructing an ExpectedEnd error.

pub fn float(err: ParseFloatError) -> Self

Shorthand for constructing an Float error.

pub fn int(err: ParseIntError) -> Self

Shorthand for constructing an Int error.

pub fn io(err: Error) -> Self

Shorthand for constructing an Io error.

pub fn literal_mismatch() -> Self

Shorthand for constructing a LiteralMismatch error.

pub fn syntax(desc: &'static str) -> Self

Shorthand for constructing a Syntax error.

pub fn syntax_no_message() -> Self

Shorthand for constructing a SyntaxNoMessage error.

pub fn other<E: Into<Box<dyn Error>>>(err: E) -> Self

Shorthand for constructing an Other error.

pub fn furthest_along(self, other: Self) -> Self

Compare two ScanErrors, and return the one which occurred the furthest into the input cursor.

pub fn add_offset(self, bytes: usize) -> Self

Adds the given number of bytes to the error’s position.

This is used where an error has been generated by trying to scan a subslice of the original input, and the position needs to be corrected.

Trait Implementations

impl Debug for ScanError

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

Formats the value using the given formatter.

impl<'a> Display for ScanError

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

Formats the value using the given formatter.

impl Error for ScanError

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

Returns the lower-level source of this error, if any.

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.