Struct YamlError 

pub struct YamlError { /* private fields */ }

A YAML parse or emit failure, owned by this crate.

The YAML engine is serde-saphyr, whose version series is 0.0.x: every release of it is a semver break under Cargo’s rules. Returning its error types from a public signature would chain this crate’s major version to that cadence, so the boundary converts to this type instead and no public signature names the engine. The engine is an implementation detail; this is what the contract says it is.

line/column are 1-indexed and present only when the engine located the failure: always absent on the emit side, which has no input to point at.

Implementations

impl YamlError

pub fn message(&self) -> &str

What went wrong, in YAML terms.

pub fn hint(&self) -> Option<&str>

The concrete textual fix, when the failure is one this crate recognizes.

pub fn line(&self) -> Option<u32>

1-indexed line of the failure, when the engine located one.

pub fn column(&self) -> Option<u32>

1-indexed column of the failure, paired with Self::line.

pub fn to_diagnostic(&self, code: &str, file: &str) -> Diagnostic

A diagnostic under code, carrying the hint and (when the engine located the failure) a Location against file.

Trait Implementations

impl Clone for YamlError

fn clone(&self) -> YamlError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YamlError

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

Formats the value using the given formatter.

impl Display for YamlError

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

Formats the value using the given formatter.

impl Eq for YamlError

impl Error for YamlError

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 YamlError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for YamlError