Enum FormatError 

pub enum FormatError {
    ExecutableNotFound {
        executable: String,
        env: &'static str,
    },
    SpawnFailed {
        executable: String,
        source: Error,
    },
    InvocationFailed {
        executable: String,
        status: ExitStatusKind,
        stderr: String,
    },
}

Errors surfaced by the runner.

Variants

ExecutableNotFound

The formatter executable was not found on the host. Surfaces the executable name the runner attempted to spawn and an actionable hint.

Fields

executable: String

Executable Cabin tried to spawn.

env: &'static str

Name of the override env var.

SpawnFailed

Spawning the formatter failed with an I/O error other than “not found”. Wraps the underlying error so the caller can render it verbatim.

Fields

executable: String

Executable Cabin tried to spawn.

source: Error

Underlying spawn error.

InvocationFailed

The formatter ran but reported a non-zero exit status outside the documented “check-mode signals a diff” contract. Captured stderr (if any) is preserved so the CLI can show it to the user.

Fields

executable: String

Executable Cabin tried to spawn.

status: ExitStatusKind

The reported exit status. None when the process was killed by a signal; the OS-specific code (if any) is included in the message via the formatter.

stderr: String

Captured stderr, trimmed of trailing whitespace. Empty when the formatter produced no stderr.

Trait Implementations

impl Debug for FormatError

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

Formats the value using the given formatter.

impl Display for FormatError

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

Formats the value using the given formatter.

impl Error for FormatError

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.