Enum DocumentError 

pub enum DocumentError {
    EmptyPath,
    EmptyValues,
    UnknownSegment {
        path: String,
        segment: String,
    },
    UnregisteredArray {
        path: String,
    },
    SlugNotFound {
        prefix: String,
        slug: String,
    },
    SlugAlreadyExists {
        prefix: String,
        slug: String,
    },
    NotTraversable {
        path: String,
        got: String,
    },
    TypeMismatch {
        path: String,
        expected: String,
        got: String,
        hint: Option<String>,
    },
    PathNotFound {
        path: String,
    },
    IndexOutOfBounds {
        path: String,
        index: usize,
        len: usize,
    },
    ParseError {
        format: String,
        detail: String,
    },
    IoError {
        detail: String,
    },
    UnsupportedOperation {
        format: String,
        operation: String,
        detail: String,
    },
}

Variants

EmptyPath

EmptyValues

UnknownSegment

Fields

path: String

segment: String

UnregisteredArray

Fields

path: String

SlugNotFound

Fields

prefix: String

slug: String

SlugAlreadyExists

Fields

prefix: String

slug: String

NotTraversable

Fields

path: String

got: String

TypeMismatch

Fields

path: String

expected: String

got: String

hint: Option<String>

PathNotFound

Fields

path: String

IndexOutOfBounds

Fields

path: String

index: usize

len: usize

ParseError

Fields

format: String

detail: String

IoError

Fields

detail: String

UnsupportedOperation

Fields

format: String

operation: String

detail: String

Implementations

impl DocumentError

pub const fn code(&self) -> &'static str

Stable, program-decidable error code for this failure category.

Multiple variants can share a code when callers should handle them in the same way. In particular, all read-address failures report document_path_not_found.

pub fn location(&self) -> Option<String>

Best-effort, content-free source location for a parse failure.

Returns e.g. "line 5 column 12" (or "line 5") for a DocumentError::ParseError, and None for every other variant or when the underlying parser reported no position. The returned string is derived from the parser’s position only and never contains document content, so it is safe to surface even when the parsed file may hold secrets.

pub fn redacted_message(&self) -> String

A display message with any potentially content-bearing detail removed — safe to surface when the document may hold secrets.

A DocumentError::ParseError renders as failed to parse {format} (with the location appended when known) and drops the raw parser detail, which can echo a snippet of the source. Every other variant renders the same as its [Display], since those carry only structural context (paths, type and format names), not content.

pub fn from_serde(path: impl Into<String>, err: impl Display) -> Self

Wrap a serde deserialization failure as a TypeMismatch so callers that do a read-modify-write cycle (set_path → serde round-trip) surface a consistent error style rather than a raw serde message.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

fn from(err: Error) -> Self

Converts to this type from the input type.