Struct ScanError 

pub struct ScanError { /* private fields */ }

An error that occurred while reading, scanning, or parsing YAML.

Implementations

impl ScanError

pub fn new(loc: Marker, message: impl Into<String>) -> ScanError

Create an externally supplied error from a location and message.

The message is stored in ErrorKind::Custom. This is useful for adapters that participate in parser APIs, such as a custom ParserTrait implementation or a ParserStack include resolver.

pub fn marker(&self) -> &Marker

Return the marker pointing to the error in the source.

pub fn kind(&self) -> &ErrorKind

Return the machine-readable error category.

pub fn try_into_input_io_error(self) -> Result<InputIoError, Self>

Extract the input I/O error details without cloning them.

Errors

Returns the original scan error unchanged when it has a different error category.

pub fn source_stack(&self) -> &[String]

Return source names captured by a parser stack, from bottom to top.

pub fn info(&self) -> String

Render the error as a human-readable description.

Parser-stack errors include their nested source names. The result remains empty when the error_messages feature is disabled.

Trait Implementations

impl Clone for ScanError

fn clone(&self) -> ScanError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanError

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

Formats the value using the given formatter.

impl Display for ScanError

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

Formats the value using the given formatter.

impl Eq for ScanError

impl Error for ScanError

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<E> From<ScanError> for TryLoadError<E>

fn from(error: ScanError) -> Self

Converts to this type from the input type.

impl PartialEq for ScanError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScanError