Enum FormatResult 

pub enum FormatResult {
    Formatted(String),
    NoOp {
        reason: String,
    },
}

The outcome of a format request.

On success it carries the canonically-formatted text. On any failure path — unparseable input, error-recovered tree, no clean subtree boundary, or a verify-before-replace mismatch — it carries a human-readable reason and the caller’s original bytes are left unchanged (the formatter never performs a partial rewrite, project-instructions §I).

Variants

Formatted(String)

Formatting succeeded; the canonical text is enclosed.

NoOp

Formatting was declined; the document is unchanged. reason explains why (suitable for a non-blocking notice).

Fields

reason: String

Why the formatter declined (e.g. “input has parse errors”).

Implementations

impl FormatResult

pub fn formatted(&self) -> Option<&str>

The formatted text, if formatting succeeded.

pub fn is_no_op(&self) -> bool

true if formatting was declined (a no-op).

Trait Implementations

impl Clone for FormatResult

fn clone(&self) -> FormatResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatResult

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

Formats the value using the given formatter.

impl Eq for FormatResult

impl PartialEq for FormatResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FormatResult