Enum DocumentError 

pub enum DocumentError {
    Utf8 {
        source: Utf8Error,
    },
    Text(TextError),
    Value {
        path: KeyPath,
        source: ValueError,
    },
    Annotation {
        path: KeyPath,
        source: AnnotationError,
    },
    Columns(ColumnsError),
    Ownership(OwnershipError),
    LineEnding(LineEndingError),
    Merge(MergeError),
    Json(JsonError),
    Markdown(MarkdownError),
    Toml(TomlError),
    Yaml(YamlError),
    Internal(InternalError),
}

Error returned by document validation, rendering, and reconciliation.

Variants

Utf8

A document’s bytes are not valid UTF-8.

Fields

source: Utf8Error

The underlying UTF-8 decoding error.

Text(TextError)

A plain text document’s comment nodes could not be rendered.

Value

A generic structured value could not be shaped for its format.

Fields

path: KeyPath

Where in the value the problem is.

source: ValueError

What is wrong with the value.

Annotation

An inline annotation marker is malformed.

Fields

path: KeyPath

Where in the value the marker is.

source: AnnotationError

What is wrong with the marker.

Columns(ColumnsError)

A column count is invalid.

Ownership(OwnershipError)

An ownership declaration is invalid.

LineEnding(LineEndingError)

A document’s line endings are inconsistent.

Merge(MergeError)

A desired document cannot be merged into the current one.

Json(JsonError)

A JSON or JSON5 document is malformed.

Markdown(MarkdownError)

A Markdown document or selector is malformed.

Toml(TomlError)

A TOML document or selector is malformed.

Yaml(YamlError)

A YAML document is malformed.

Internal(InternalError)

A bug in this crate, not a problem with the input.

Implementations

impl DocumentError

pub(crate) const fn value(source: ValueError) -> Self

pub(crate) fn not_string(path: &[String]) -> Self

The value at path is not a string.

pub(crate) fn yaml_parse(source: YamlError) -> Self

pub(crate) const fn annotation(source: AnnotationError) -> Self

pub(crate) fn under(self, segment: Segment) -> Self

Prefix the key path of a value, annotation or duplicate key error with segment. Every other error is returned unchanged.

Trait Implementations

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

fn from(source: ColumnsError) -> Self

Converts to this type from the input type.

impl From<InternalError> for DocumentError

fn from(source: InternalError) -> Self

Converts to this type from the input type.

impl From<JsonError> for DocumentError

fn from(source: JsonError) -> Self

Converts to this type from the input type.

impl From<LineEndingError> for DocumentError

fn from(source: LineEndingError) -> Self

Converts to this type from the input type.

impl From<MarkdownError> for DocumentError

fn from(source: MarkdownError) -> Self

Converts to this type from the input type.

impl From<MergeError> for DocumentError

fn from(source: MergeError) -> Self

Converts to this type from the input type.

impl From<OwnershipError> for DocumentError

fn from(source: OwnershipError) -> Self

Converts to this type from the input type.

impl From<TextError> for DocumentError

fn from(source: TextError) -> Self

Converts to this type from the input type.

impl From<TomlError> for DocumentError

fn from(source: TomlError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for DocumentError

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.

impl From<YamlError> for DocumentError

fn from(source: YamlError) -> Self

Converts to this type from the input type.