Enum FormatError 

pub enum FormatError {
    NotFound {
        program: String,
    },
    Failed {
        program: String,
        stderr: String,
    },
    TimedOut {
        program: String,
    },
    NotUtf8 {
        program: String,
    },
    Io {
        program: String,
        message: String,
    },
}

Why a formatter run produced no edits.

Every variant is a case the caller must handle differently, which is why this is not a String: “not installed” is routine and silent on save, “non-zero exit” carries diagnostics the user needs to see, and “timed out” means a process was killed.

Variants

NotFound

The program is not on PATH. Routine — a user without prettier installed should not be nagged on every save.

Fields

program: String

Failed

The formatter ran and rejected the input. stderr is the compiler-style diagnostic and belongs in front of the user.

Fields

program: String

stderr: String

TimedOut

Killed at FORMAT_TIMEOUT.

Fields

program: String

NotUtf8

The formatter wrote bytes that are not UTF-8. Refusing is the only safe answer: splicing them into the rope would corrupt the buffer.

Fields

program: String

Io

Spawning or piping failed for a reason other than the program being absent.

Fields

program: String

message: String

Implementations

impl FormatError

pub fn message(&self) -> String

One-line form for the echo area.

pub fn is_noteworthy(&self) -> bool

Whether this is worth interrupting the user for.

NotFound is not: it means the tool simply is not installed, which is a configuration state rather than an event. The others describe something that went wrong during work the user asked for.

Trait Implementations

impl Clone for FormatError

fn clone(&self) -> FormatError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatError

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

Formats the value using the given formatter.

impl Eq for FormatError

impl PartialEq for FormatError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FormatError