Skip to main content

ClientError

Enum ClientError 

Source
pub enum ClientError {
    NotFound {
        detail: ErrorDetail,
    },
    AlreadyExists {
        detail: ErrorDetail,
    },
    QueryFailed {
        detail: ErrorDetail,
    },
    QueryTimeout {
        detail: ErrorDetail,
    },
    UnknownQuery {
        detail: ErrorDetail,
    },
    NotRunning {
        detail: ErrorDetail,
    },
    Cancelled {
        detail: ErrorDetail,
    },
    Unavailable {
        detail: ErrorDetail,
    },
    Unauthenticated {
        detail: ErrorDetail,
    },
    NamespaceDenied {
        detail: ErrorDetail,
    },
    InvalidArgument {
        detail: ErrorDetail,
    },
    Server {
        detail: ErrorDetail,
    },
}
Expand description

Branchable caller-side error taxonomy shared by every aion client SDK.

Display renders <class>: <detail> where <class> is the stable string returned by ClientError::class, aligned with the wire error codes (not_found, namespace_denied, invalid_input, backend, …).

Variants§

§

NotFound

The requested workflow or run does not exist.

Fields

§detail: ErrorDetail

Server-supplied detail message.

§

AlreadyExists

A caller-supplied idempotency key conflicts with a different request.

Fields

§detail: ErrorDetail

Conflict detail message.

§

QueryFailed

The workflow query handler ran and reported an application failure.

Fields

§detail: ErrorDetail

Handler failure detail reported by the workflow.

§

QueryTimeout

The workflow query exceeded its deadline.

Fields

§detail: ErrorDetail

Deadline detail (server window or local deadline).

§

UnknownQuery

The requested workflow query name is not registered.

Fields

§detail: ErrorDetail

Server-supplied detail naming the unknown query.

§

NotRunning

The target workflow is terminal or otherwise not running.

Fields

§detail: ErrorDetail

Server-supplied detail about the non-running target.

§

Cancelled

The call or target workflow was cancelled.

Fields

§detail: ErrorDetail

Cancellation detail message.

§

Unavailable

The server or network transport is unavailable.

Fields

§detail: ErrorDetail

Transport/connection failure detail.

§

Unauthenticated

Authentication credentials were rejected.

Fields

§detail: ErrorDetail

Credential rejection detail.

§

NamespaceDenied

The caller’s credential was accepted, but the caller has no grant for the requested namespace.

This is exactly a namespace-grant failure. Workflow-level invisibility — the workflow does not exist, or is owned by another namespace — is reported as ClientError::NotFound so a cross-tenant probe is indistinguishable from a nonexistent workflow.

Maps from the AW wire error code namespace_denied and gRPC PERMISSION_DENIED. Distinct from ClientError::Unauthenticated (credential rejected or unvalidatable) and from ClientError::InvalidArgument (malformed or invalid request). Not retryable until the caller’s grants change.

Fields

§detail: ErrorDetail

Server-supplied denial detail message.

§

InvalidArgument

The request was malformed or targets an unsupported operation state.

Fields

§detail: ErrorDetail

Precise description of what was invalid and how to fix it.

§

Server

The server reported an unexpected internal failure.

Fields

§detail: ErrorDetail

Informational server detail.

Implementations§

Source§

impl ClientError

Source

pub fn not_found(detail: impl Into<ErrorDetail>) -> Self

Creates a not-found error.

Source

pub fn already_exists(detail: impl Into<ErrorDetail>) -> Self

Creates an idempotency-conflict error.

Source

pub fn query_failed(detail: impl Into<ErrorDetail>) -> Self

Creates a query-handler failure.

Source

pub fn query_timeout(detail: impl Into<ErrorDetail>) -> Self

Creates a query timeout.

Source

pub fn unknown_query(detail: impl Into<ErrorDetail>) -> Self

Creates an unknown-query error.

Source

pub fn not_running(detail: impl Into<ErrorDetail>) -> Self

Creates a not-running error.

Source

pub fn cancelled(detail: impl Into<ErrorDetail>) -> Self

Creates a cancellation error.

Source

pub fn unavailable(detail: impl Into<ErrorDetail>) -> Self

Creates a transport-unavailable error.

Source

pub fn unauthenticated(detail: impl Into<ErrorDetail>) -> Self

Creates a credential-rejection error.

Source

pub fn namespace_denied(detail: impl Into<ErrorDetail>) -> Self

Creates a namespace-grant denial.

Source

pub fn invalid_argument(detail: impl Into<ErrorDetail>) -> Self

Creates an ClientError::InvalidArgument carrying a precise message.

Source

pub fn server(detail: impl Into<ErrorDetail>) -> Self

Creates an unexpected-server-failure error from a local conversion or server detail.

Source

pub const fn class(&self) -> &'static str

Stable taxonomy class string, aligned with the wire error codes.

Source

pub const fn detail(&self) -> &ErrorDetail

The diagnostic detail carried by this error.

Source

pub fn from_wire_error(error: WireError) -> Self

Converts an AW wire error into the client SDK taxonomy, preserving the server’s message and error_type in the carried ErrorDetail.

Source

pub fn from_proto_wire_error(error: ProtoWireError) -> Self

Converts a proto-encoded wire error into the client SDK taxonomy.

Source

pub fn from_status(status: &Status) -> Self

Converts a tonic status into the client SDK taxonomy.

The server encodes the full typed WireError (code, message, error_type) into the status details; when present it is authoritative. Without decodable details the gRPC code is mapped and the status message becomes the detail, so the server’s human detail is never dropped.

Source

pub fn from_transport_error(error: &Error) -> Self

Converts a tonic transport failure into the client SDK taxonomy, preserving the full transport error chain as the detail message.

Trait Implementations§

Source§

impl Clone for ClientError

Source§

fn clone(&self) -> ClientError

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 ClientError

Source§

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

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

impl Display for ClientError

Source§

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

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

impl Eq for ClientError

Source§

impl Error for ClientError

1.30.0 · 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
Source§

impl PartialEq for ClientError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ClientError

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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