Struct DocumentError 

pub struct DocumentError {
    pub path: String,
    pub code: Option<String>,
    pub message: String,
}

A Document operation is invalid, or a plain value is not a legal Document.

Raised by crate::document when a construction or mutation would produce something outside the Document model (a bare top-level array, an array of arrays, nesting past the max depth) or when an operation doesn’t fit the node it’s called on (e.g. reading .value() on an internal node). The message carries the offending path, matching the Python reference’s DocumentError convention of embedding path in the text.

Fields

path: String

The path inside the document where the error occurred.

code: Option<String>

The spec’s stable machine-readable code (omnist-spec §8.3.2 and §8.3.8, e.g. document.unlabeled-element, format.dtd-forbidden), when the failure is one the taxonomy names. None for API-misuse errors (reading .value() on an internal node, get_one on a repeated label, …) that no conformance diagnostic describes.

message: String

Human-readable error description.

Implementations

impl DocumentError

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

Construct a new DocumentError at the given path, with no taxonomy code (an API-misuse error).

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

Construct a DocumentError carrying a spec taxonomy code.

Trait Implementations

impl Clone for DocumentError

fn clone(&self) -> DocumentError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentError

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

Formats the value using the given formatter.

impl Display for DocumentError

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

Formats the value using the given formatter.

impl Eq for DocumentError

impl Error for DocumentError

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<DocumentError> for OmnistError

fn from(source: DocumentError) -> Self

Converts to this type from the input type.

impl PartialEq for DocumentError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocumentError