Struct Error 

pub struct Error { /* private fields */ }

Opaque canonical RocketMQ error.

Identity and policy are owned by a reviewed catalog descriptor. Each value retains typed context, at most one direct typed source, its first-promotion caller location, and an optional catalog-controlled backtrace behind one boxed pointer.

Error is intentionally not cloneable. Use SharedError when multiple owners must observe the same error instance.

use rocketmq_error::{Error, CORE_INTERNAL_FAILURE};

let error = Error::new(&CORE_INTERNAL_FAILURE);
let _copy = error.clone();

Implementations

impl Error

pub fn new(descriptor: &'static ErrorDescriptor) -> Self

Creates a source-free canonical error from a catalog descriptor.

pub fn caused_by( descriptor: &'static ErrorDescriptor, source: impl StdError + Send + Sync + 'static, ) -> Self

Creates a canonical error while retaining the direct typed source.

pub fn with_context(self, context: ErrorContext) -> Self

Replaces the typed context without changing source or provenance.

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

Replaces the direct typed source without changing context or provenance.

pub fn with_boxed_source( self, source: Box<dyn StdError + Send + Sync + 'static>, ) -> Self

Replaces the direct boxed source without adding another causal layer.

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

Returns the catalog descriptor that owns identity and policy.

pub const fn code(&self) -> ErrorCode

Returns the stable catalog code.

pub const fn class(&self) -> ErrorClass

Returns the broad catalog-owned class.

pub const fn condition(&self) -> CanonicalCondition

Returns the protocol-independent canonical condition.

pub const fn fault(&self) -> FaultAttribution

Returns the catalog-owned fault attribution.

pub const fn component(&self) -> ComponentId

Returns the catalog component that owns this identity.

pub const fn severity(&self) -> ErrorSeverity

Returns the catalog-owned severity.

pub const fn recovery_hint(&self) -> RecoveryHint

Returns the catalog-owned recovery hint.

pub const fn exposure(&self) -> Exposure

Returns the public-context exposure policy.

pub const fn backtrace_policy(&self) -> BacktracePolicy

Returns the catalog-controlled backtrace policy.

pub const fn projection(&self) -> ProjectionSpec

Returns descriptor-owned boundary projections.

pub const 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 const fn location(&self) -> &'static Location<'static>

Returns the first-promotion caller location.

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

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

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<&Error> for CliErrorView

fn from(error: &Error) -> Self

Converts to this type from the input type.

impl From<FilterCompileError> for Error

fn from(source: FilterCompileError) -> Self

Converts to this type from the input type.