Enum Error 

pub enum Error {
    Duplicate(ElemId),
    Conflict {
        outer: ElemId,
        inner: ElemId,
    },
    UnknownElement(ElemId),
    Removal(RemovalError),
    Internal(Error),
    OutputTooLarge,
    OverlappingSpans {
        first: Span,
        second: Span,
    },
}

Why a set of Edits could not be applied.

Most of these say the edits asked for something contradictory, or named an element that is not there, and the caller can act on them. Error::Internal and Error::OverlappingSpans are different in kind: no set of edits can ask for either, so reaching one is a bug in this module rather than anything the caller did. They are returned rather than panicked on because the caller is about to write the result over someone’s tariff, and refusing to is better than crashing in their process or, worse, handing back JSON that has been corrupted.

Variants

Duplicate(ElemId)

More than one replacement targets this element, and they disagree about the text.

Conflict

Applying outer would silently discard the edit to inner, which sits inside it.

Fields

outer: ElemId

The replaced element.

inner: ElemId

The element edited inside it.

UnknownElement(ElemId)

The document has no element with this id.

Removal(RemovalError)

The removals could not be resolved to spans.

Internal(Error)

Splicing produced source that is no longer valid JSON, which is a bug in this module.

A replacement carries a payload that is one JSON value by construction, and a value is legal wherever another value was, so no payload should cause this. What is left is the removal spans and the splice itself, so reaching this means one of those is wrong - or, in a release build, that a payload builder is, since its own assertion is compiled out.

OutputTooLarge

The spliced source exceeds the maximum size deemed reasonable.

A caller can reach this: replacements longer than what they stand in for can take a document that was within the limit past it. This is the only size bound in the module, and it is on the whole output, since a bound on one payload would not catch that.

OverlappingSpans

Two resolved spans overlap, so erasing both would corrupt the output. No set of edits should reach this; it means resolution itself is wrong.

Fields

first: Span

The span that starts first.

second: Span

The span that starts inside it.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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 Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error