Struct WriteError 

pub struct WriteError {
    pub message: String,
    pub report: Option<WriteReport>,
    pub path: Option<String>,
    pub code: Option<String>,
}

An in-memory Document could not be written – raised by crate::oml::write_oml (depth guard only; OML is otherwise lossless for every Document – see that module’s doc comment) and, from issue #16 onward, by strict=true format writers via crate::report::finish_write, mirroring Python’s WriteError(str(rep), report=rep). The optional crate::report::WriteReport carries the adjustments that triggered a strict-mode raise; None for every other WriteError site (e.g. the depth guard, which has no report to attach).

Fields

message: String

Human-readable write failure description.

report: Option<WriteReport>

Optional accumulated WriteReport when written in strict mode.

path: Option<String>

The Document path of the value that could not be written, when the failure is one the spec’s taxonomy names (omnist-spec §8.3.8 and §8.3.9); None otherwise.

code: Option<String>

The spec’s stable code for the failure (write.unsupported-value, format.multiple-roots, …); None when the taxonomy has no code for it.

Implementations

impl WriteError

pub fn new(message: impl Into<String>) -> Self

Construct a new WriteError with no report.

pub fn with_diagnostic( path: impl Into<String>, code: impl Into<String>, message: impl Into<String>, ) -> Self

Construct a WriteError that carries the structured (path, code) diagnostic the spec’s taxonomy assigns to it.

pub fn with_report(message: impl Into<String>, report: WriteReport) -> Self

Construct a WriteError carrying the crate::report::WriteReport that caused a strict-mode write to raise.

pub fn report(&self) -> Option<&WriteReport>

The report attached to this error, if any (only strict-mode format writers attach one).

Trait Implementations

impl Clone for WriteError

fn clone(&self) -> WriteError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteError

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

Formats the value using the given formatter.

impl Display for WriteError

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

Formats the value using the given formatter.

impl Eq for WriteError

impl Error for WriteError

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 From<DocumentError> for WriteError

fn from(e: DocumentError) -> Self

Converts to this type from the input type.

impl From<WriteError> for OmnistError

fn from(source: WriteError) -> Self

Converts to this type from the input type.

impl PartialEq for WriteError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WriteError