Struct ClientError 

pub struct ClientError(/* private fields */);

Opaque client boundary error backed by one shared canonical error.

Client operations cross asynchronous callbacks and retry coordinators, so the canonical value is shared rather than copied or flattened into text.

Implementations

impl ClientError

pub fn from_error(error: Error) -> Self

Promotes an owned canonical error into the client boundary.

pub const fn from_shared(error: SharedError) -> Self

Retains an already shared canonical error at the client boundary.

pub fn descriptor(&self) -> &'static ErrorDescriptor

Returns the canonical error descriptor.

pub fn is(&self, descriptor: &'static ErrorDescriptor) -> bool

Returns whether this error has the supplied canonical identity.

pub fn broker_response_code(&self) -> Option<i32>

Returns the retained broker response code when this is a broker failure.

pub fn broker_addr(&self) -> Option<&str>

Returns the bounded diagnostic broker address when present.

pub const fn shared_error(&self) -> &SharedError

Borrows the shared canonical error.

pub fn source_ref<T>(&self) -> Option<&T>

where T: StdError + 'static,

Finds a typed cause anywhere below the canonical client error.

pub fn into_shared_error(self) -> SharedError

Returns the shared canonical error.

pub fn into_error(self) -> Error

Returns an owned canonical error while preserving the complete typed source chain when the shared value has other owners.

pub fn illegal_argument(message: impl Into<String>) -> Self

Creates an invalid-argument failure without retaining arbitrary text.

pub fn illegal_argument_source( source: impl StdError + Send + Sync + 'static, ) -> Self

Creates an invalid-argument failure with a typed source.

pub fn not_started() -> Self

Creates a client-not-started lifecycle failure.

pub fn already_started() -> Self

Creates a client-already-started lifecycle failure.

pub fn shutting_down() -> Self

Creates a client-shutting-down lifecycle failure.

pub fn invalid_state(expected: impl AsRef<str>, actual: impl AsRef<str>) -> Self

Creates an invalid client-state failure.

pub fn component_unavailable(role: impl AsRef<str>) -> Self

Creates an unavailable client-component failure.

pub fn not_initialized(component: impl AsRef<str>) -> Self

Creates a component-not-initialized failure.

pub fn config_missing(key: impl AsRef<str>) -> Self

Creates a configuration-missing failure.

pub fn config_invalid( key: impl AsRef<str>, value: impl AsRef<str>, reason: impl AsRef<str>, ) -> Self

Creates an invalid-configuration failure.

pub fn config_invalid_source( key: impl AsRef<str>, value_present: bool, source: impl StdError + Send + Sync + 'static, ) -> Self

Creates an invalid-configuration failure with a typed source.

pub fn config_parse_failed( key: impl AsRef<str>, reason: impl AsRef<str>, ) -> Self

Creates a configuration-parse failure.

pub fn config_parse_source( key: impl AsRef<str>, source: impl StdError + Send + Sync + 'static, ) -> Self

Creates a configuration-parse failure with a typed source.

pub fn response_process_failed( operation: impl AsRef<str>, reason: impl AsRef<str>, ) -> Self

Creates a response-processing failure.

pub fn response_process_source( operation: impl AsRef<str>, source: impl StdError + Send + Sync + 'static, ) -> Self

Creates a response-processing failure with a typed source.

pub fn timeout(operation: impl AsRef<str>, timeout_ms: u64) -> Self

Creates an operation-timeout failure.

pub fn internal( operation: impl AsRef<str>, source: impl StdError + Send + Sync + 'static, ) -> Self

Creates an internal failure while retaining its typed source.

pub fn invariant_violated(invariant: impl AsRef<str>) -> Self

Creates an invariant failure.

pub fn service_failed(operation: impl AsRef<str>) -> Self

Creates a service lifecycle failure.

pub fn service_source( operation: impl AsRef<str>, source: impl StdError + Send + Sync + 'static, ) -> Self

Creates a service lifecycle failure with a typed source.

pub fn invalid_property(property: impl AsRef<str>) -> Self

Creates an invalid-message-property failure.

pub fn broker_not_found(broker: impl AsRef<str>) -> Self

Creates a broker-lookup failure.

pub fn broker_operation_failed( operation: impl AsRef<str>, code: i32, message: impl AsRef<str>, ) -> Self

Creates a broker-operation failure.

pub fn broker_operation_failed_at( operation: impl AsRef<str>, code: i32, message: impl AsRef<str>, broker_addr: Option<impl AsRef<str>>, ) -> Self

Creates a broker-operation failure with an optional broker address.

pub fn broker_operation_source( operation: impl AsRef<str>, code: i32, broker_addr: Option<impl AsRef<str>>, source: impl StdError + Send + Sync + 'static, ) -> Self

Creates a broker-operation failure while retaining its typed source.

pub fn with_broker_addr(self, broker_addr: impl AsRef<str>) -> Self

Adds a broker address to a newly created broker-operation failure.

pub fn route_not_found(topic: impl AsRef<str>) -> Self

Creates a route-not-found failure.

pub fn dns_failed() -> Self

Creates a DNS-resolution failure without exposing endpoint details.

pub fn dns_failed_source(source: impl StdError + Send + Sync + 'static) -> Self

Creates a DNS-resolution failure while retaining its typed source.

Methods from Deref<Target = Error>

pub fn descriptor(&self) -> &'static ErrorDescriptor

Returns the catalog descriptor that owns identity and policy.

pub fn code(&self) -> ErrorCode

Returns the stable catalog code.

pub fn class(&self) -> ErrorClass

Returns the broad catalog-owned class.

pub fn condition(&self) -> CanonicalCondition

Returns the protocol-independent canonical condition.

pub fn fault(&self) -> FaultAttribution

Returns the catalog-owned fault attribution.

pub fn component(&self) -> ComponentId

Returns the catalog component that owns this identity.

pub fn severity(&self) -> ErrorSeverity

Returns the catalog-owned severity.

pub fn recovery_hint(&self) -> RecoveryHint

Returns the catalog-owned recovery hint.

pub fn exposure(&self) -> Exposure

Returns the public-context exposure policy.

pub fn backtrace_policy(&self) -> BacktracePolicy

Returns the catalog-controlled backtrace policy.

pub fn projection(&self) -> ProjectionSpec

Returns descriptor-owned boundary projections.

pub fn context(&self) -> &ErrorContext

Returns the typed context retained by this error.

pub fn public_view(&self) -> Result<PublicErrorView<'_>, ViewContextViolation>

Creates a descriptor-validated public projection.

Errors

Returns an error when the retained context does not match the selected catalog descriptor.

pub fn diagnostic_view( &self, ) -> Result<DiagnosticView<'_>, ViewContextViolation>

Creates a descriptor-validated diagnostic projection.

The view never includes the source, caller location, or backtrace.

Errors

Returns an error when the retained context does not match the selected catalog descriptor.

pub fn location(&self) -> &'static Location<'static>

Returns the first-promotion caller location.

pub fn backtrace(&self) -> Option<&Backtrace>

Returns the captured backtrace, if standard-library capture was enabled.

Trait Implementations

impl AsRef<Error> for ClientError

fn as_ref(&self) -> &Error

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ClientError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Deref for ClientError

type Target = Error

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Error for ClientError

fn source(&self) -> Option<&(dyn StdError + '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<Arc<Error>> for ClientError

fn from(error: SharedError) -> Self

Converts to this type from the input type.

impl From<ClientError> for SharedError

fn from(error: ClientError) -> Self

Converts to this type from the input type.

impl From<Error> for ClientError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<MQBrokerException> for ClientError

fn from(exception: MQBrokerException) -> Self

Converts to this type from the input type.

impl From<MQClientException> for ClientError

fn from(exception: MQClientException) -> Self

Converts to this type from the input type.

impl From<OffsetNotFoundException> for ClientError

fn from(exception: OffsetNotFoundException) -> Self

Converts to this type from the input type.

impl From<RequestTimeoutException> for ClientError

fn from(_exception: RequestTimeoutException) -> Self

Converts to this type from the input type.