Skip to main content

CliError

Enum CliError 

Source
pub enum CliError {
    Config {
        detail: String,
        file: Option<String>,
        suggestion: String,
    },
    Contract {
        detail: String,
        diagnostics: Vec<String>,
    },
    Link {
        detail: String,
        diagnostics: Vec<String>,
    },
    Runtime {
        detail: String,
        context: Option<String>,
    },
    Packaging {
        detail: String,
        suggestion: String,
    },
    Security {
        detail: String,
        suggestion: String,
    },
    Environment {
        detail: String,
        fix: String,
    },
    Io {
        detail: String,
        path: Option<String>,
    },
    Internal {
        detail: String,
    },
    NotImplemented {
        command: String,
    },
}
Expand description

Top-level CLI error type.

§Invariants

  • Every variant maps to a specific exit code.
  • Every variant carries enough context for a four-part error message.

§Error codes (per Doc 10 C07-2, Doc 09 G-08)

  • E0001–E0099: General CLI errors
  • E0100–E0199: Contract errors
  • E0200–E0299: Linking errors
  • E0300–E0399: Resource errors
  • E0400–E0499: Reactor errors
  • E0500–E0599: Security errors
  • E0600–E0699: Packaging errors
  • E0700–E0799: Configuration errors

Variants§

§

Config

Configuration file not found or invalid.

Fields

§detail: String

What went wrong.

§file: Option<String>

File path (if applicable).

§suggestion: String

How to fix it.

§

Contract

WIT contract validation failure.

Fields

§detail: String

What went wrong.

§diagnostics: Vec<String>

Detailed diagnostic messages.

Pipeline linking/composition failure.

Fields

§detail: String

What went wrong.

§diagnostics: Vec<String>

Detailed diagnostic messages.

§

Runtime

Runtime execution failure.

Fields

§detail: String

What went wrong.

§context: Option<String>

Additional context.

§

Packaging

Packaging or publish failure.

Fields

§detail: String

What went wrong.

§suggestion: String

How to fix it.

§

Security

Security/capability failure.

Fields

§detail: String

What went wrong.

§suggestion: String

How to fix it.

§

Environment

Environment issue (missing tool, wrong version).

Fields

§detail: String

What went wrong.

§fix: String

How to fix it.

§

Io

Filesystem error (can’t create directory, can’t write file).

Fields

§detail: String

What went wrong.

§path: Option<String>

File path (if applicable).

§

Internal

Generic internal error (should not normally reach users).

Fields

§detail: String

What went wrong.

§

NotImplemented

Command not yet implemented.

Fields

§command: String

Command name.

Implementations§

Source§

impl CliError

Source

pub fn exit_code(&self) -> i32

Map this error to a process exit code.

  • Returns 1 for command failures (validation, runtime, packaging).
  • Returns 2 for usage errors (bad config, missing files).
  • Returns 3 for environment errors (missing tools).
Source

pub fn render(&self, ctx: &OutputContext)

Render this error to the terminal.

COLD PATH — called at most once per invocation.

Trait Implementations§

Source§

impl Debug for CliError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Error> for CliError

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.
Source§

impl From<TorvynError> for CliError

Source§

fn from(err: TorvynError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more