Enum Error 

pub enum Error {
    Parse(String),
    Edit(String),
    Residue {
        found: String,
    },
    Malformed {
        found: String,
    },
}

Why a body could not be filtered.

Every variant means the caller must not publish the body it passed in. There is no “filtered as best we could” outcome on purpose: a partial filter is indistinguishable from a complete one by inspection, and the thing it silently keeps is the thing someone declared private.

Variants

Parse(String)

The body could not be parsed, so no region in it could be located.

Edit(String)

An edit twig refused. Structural, not authorial — a bug here rather than in the document.

Residue

A marker survived the filter.

The backstop for the failure this module is most likely to have: a region spelled in a way this module does not recognize is a region nothing removed, and its content is then published to everyone. Cheap to check, and it converts the worst outcome (a silent leak) into the ordinary one (a refused publish naming the document).

Fields

found: String

What was still there, for the message.

Malformed

A region the parser could not read as one.

The signature of twig’s one structural gap here: it does not nest inline directives, so the outer half of :vis[a :vis[b]{.x} c]{.y} parses as a bare :vis carrying neither attributes nor an interior, while a, c and the {.y} that scoped them stay outside it as prose.

Unwrapping that marker would delete the word :vis and publish everything it was scoping — a leak with no marker left behind for Residue to find, which is why it is caught here by shape instead. Nested block regions are unaffected and work.

Fields

found: String

The source of the region that could not be read.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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