Struct Error 

pub struct Error { /* private fields */ }

A failure, classified once at the point it is raised.

Carries the coarse ErrorKind every consumer branches on, the optional WireKind naming the daemon status that produced it, a message that names the docs/PLATFORM.md finding when a trap closure raised it, and the underlying error when one exists.

Deliberately a struct with a private body rather than an enum: the variants a caller wants to match on are the kinds, and an enum over every raise site would make every new failure a breaking change for a binding that matched exhaustively.

Implementations

impl Error

pub fn new(kind: ErrorKind, message: impl Into<String>) -> Error

A failure of kind, with a message that should name its finding.

pub fn invalid_arg(message: impl Into<String>) -> Error

A local reject: the request was refused before any AWS call.

The shorthand exists because every trap closure in this crate ends in one, and ERR_INVALID_ARG is the code that tells a caller the fix is theirs and costs nothing.

pub fn wire(wire_kind: WireKind, message: impl Into<String>) -> Error

A failure the daemon reported by choosing a status.

The ErrorKind is derived from the WireKind rather than passed in, because the two must not be able to disagree: Unauthorized is ERR_CREDENTIALS and never ERR_PROTOCOL, and a call site free to pick both is a call site that can get that wrong once.

pub fn with_source(self, source: impl Error + Send + Sync + 'static) -> Error

Attaches the underlying error, reachable through std::error::Error::source.

pub fn with_throttled(self, throttled: bool) -> Error

Marks a control-plane throttle without parsing its explanation.

pub fn with_retry_details(self, attempts: u32, backoff: Duration) -> Error

Attaches the attempts and completed retry sleeps for this control-plane call.

pub fn throttled(&self) -> bool

Whether the service refused this call because of throttling.

pub fn attempt_count(&self) -> u32

Attempts sent for the failed call, or zero when no request telemetry is available.

pub fn backoff(&self) -> Duration

Total completed retry sleeps for this call.

pub fn kind(&self) -> ErrorKind

The coarse class, one per row of the exit-code table.

pub fn wire_kind(&self) -> Option<WireKind>

The daemon status this came from, when it came from one.

None for every local reject and every control-plane failure — those never reached the in-VM daemon, so there is no status to report.

pub fn code(&self) -> &'static str

The machine-readable ERR_* code, as cli.py’s Code spells it.

pub fn retryable(&self) -> bool

Whether retrying the identical request could plausibly succeed.

Derived from the kind rather than stored, so it cannot drift from it: the five retryable daemon conditions all map to ErrorKind::Retryable, which is what makes this one comparison instead of a second table.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.

impl From<ProvisionError> for Error

The taxonomy error a binding raises: the message, then each remedy, since a binding’s exception has nowhere else to carry them.

fn from(error: ProvisionError) -> Error

Converts to this type from the input type.

impl From<WorkspaceError> for Error

fn from(error: WorkspaceError) -> Error

ERR_INVALID_ARG: the tree is the caller’s, and so is the fix (a smaller tree, a readable path, a writable destination). Nothing the daemon said is involved.