Skip to main content

AppError

Enum AppError 

Source
#[non_exhaustive]
pub enum AppError { Structured { kind: ErrorKind, message: String, detail: Box<ErrorDetail>, retry_after_secs: Option<u64>, source: Option<Arc<dyn Error + Send + Sync>>, }, }
Expand description

Application error with structured kind for agents.

§Display

Prints only the technical English message field (lowercase, no trailing period). Walk std::error::Error::source for the cause chain; do not duplicate the cause text in message.

§Clone

Source is held in Arc so clones share the cause without re-boxing.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Structured

Structured error used by all library and CLI paths.

Fields

§kind: ErrorKind

Canonical error kind for exit codes and JSON.

§message: String

Technical English message (never localized) — the JSON wire field.

§detail: Box<ErrorDetail>

Typed catalogue entry this error was built from.

Not optional: the string constructors were removed, so every error carries its data and therefore both renderings. Boxed to keep AppError small, since most values are moved around as Result payloads rather than inspected.

§retry_after_secs: Option<u64>

Optional Retry-After hint from HTTP 429 / 503.

§source: Option<Arc<dyn Error + Send + Sync>>

Optional lower-level cause (shared via Arc for Clone).

Implementations§

Source§

impl AppError

Source

pub fn of(detail: ErrorDetail) -> Self

Build an error from the typed catalogue.

This is the constructor product code should use. Both the ErrorKind and the English wire message are derived from detail, so one failure can never be reported as two different kinds from two call sites, and it can never ship without a pt-BR rendering — the renderer’s match has no _ arm, so a missing translation fails to compile.

Source

pub fn of_with_source( detail: ErrorDetail, source: impl Error + Send + Sync + 'static, ) -> Self

Self::of with a preserved lower-level cause.

Source

pub fn localized(&self, locale: Locale) -> String

Render this error in locale, for human stderr.

Always available in both languages: the catalogue is the only way to build an AppError, and its pt-BR renderer is exhaustive.

Source

pub fn with_retry_after(self, secs: u64) -> Self

Attach optional Retry-After seconds (HTTP 429 / 503).

Source

pub fn interrupted() -> Self

SIGINT cancel.

Source

pub fn terminated() -> Self

SIGTERM cancel.

Source

pub fn broken_pipe() -> Self

stdout closed by the reader (pipe consumer exited).

Source

pub fn kind(&self) -> ErrorKind

Returns the canonical error kind.

Source

pub fn detail(&self) -> &ErrorDetail

Typed catalogue entry this error carries.

Lets a caller wrap one failure inside another (suggestions, context) without flattening it to a string and losing the pt-BR rendering.

Source

pub fn message(&self) -> &str

Returns the technical English message.

Source

pub fn retry_after_secs(&self) -> Option<u64>

Returns optional Retry-After seconds when present.

Source

pub fn retryable(&self) -> bool

Whether an agent may retry the same invocation after backoff.

This is the value that reaches error.retryable on the wire. For filesystem failures it comes from the OS cause captured where the std::io::Error was still in hand, because ENOSPC and EACCES are the same ErrorKind and opposite answers.

Source

pub fn suggestions(&self) -> Option<&[Suggestion]>

Ranked --suggest alternatives carried by this failure, if any.

Only the outermost detail is inspected: the recovery ladder wraps a not-found in exactly one ErrorDetail::WithSuggestions, and a nested one would mean two competing lists with no rule for which wins.

Source

pub fn is_retryable(&self) -> bool

Alias of Self::retryable (Rules Rust checklist name is_retryable).

Source

pub fn is_permanent(&self) -> bool

Permanent for agent auto-retry (complement of Self::is_retryable).

Source

pub fn retry_kind(&self) -> RetryKind

Detailed retry category (Rules Rust checklist retry_kind).

Source

pub fn exit_code(&self) -> ExitCode

Maps this error to a process ExitCode.

Source

pub fn from_http_status(status: u16, body_hint: &str) -> Self

Map remote HTTP status to a domain error.

body_hint must be a short, non-sensitive context label (e.g. endpoint name or "retries exhausted"), never a raw response body or credential.

Trait Implementations§

Source§

impl Clone for AppError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AppError

Source§

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

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

impl Display for AppError

Source§

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

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

impl Error for AppError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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