Struct AeronCError 

pub struct AeronCError {
    pub code: i32,
    /* private fields */
}

Aeron C API error: code + optional message.

Construction is allocation-free (never reads aeron_errmsg()), so retry loops that discard the error stay cheap. Attach the message via capture_errmsg() (at the error site) or with_message(); Display / get_last_err_message() otherwise read the live aeron_errmsg() buffer.

Fields

code: i32

Implementations

impl AeronCError

pub fn from_code(code: i32) -> Self

Construct from an Aeron error code (< 0 is failure).

Allocation-free; does not read aeron_errmsg(). Use capture_errmsg() to attach the message when the error will be stored or logged later.

pub fn with_message(code: i32, msg: impl Into<String>) -> Self

Self::from_code with an attached message.

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

Message attached via capture_errmsg() / with_message(), if any.

pub fn kind(&self) -> AeronErrorType

pub fn is_back_pressured(&self) -> bool

pub fn is_admin_action(&self) -> bool

pub fn is_back_pressured_or_admin_action(&self) -> bool

impl AeronCError

pub fn get_last_err_message(&self) -> &str

pub fn capture_errmsg(self) -> Self

Attach the current aeron_errmsg() text to this error (one allocation). Call at the error site when the error will be stored, logged later, or sent across threads — otherwise Display reads the live buffer, which a later error can overwrite.

impl AeronCError

pub fn is_retryable(&self) -> bool

Transient failure — retry the operation (back off first). See AeronErrorType::is_retryable.

pub fn is_unrecoverable(&self) -> bool

Definitively terminal — abort the operation. See AeronErrorType::is_unrecoverable. Not exhaustive: ambiguous codes are neither retryable nor unrecoverable.

Trait Implementations

impl Clone for AeronCError

fn clone(&self) -> AeronCError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AeronCError

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

Formats the value using the given formatter.

impl Display for AeronCError

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

Formats the value using the given formatter.

impl Error for AeronCError

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<AeronArchiveError> for AeronCError

Lossy interop: archive control errors flatten into AeronCError so ? works in mixed client/archive code paths. The original typed code is not preserved (the C client error domain has no equivalent slot for it); use AeronArchiveError directly at archive control sites to retain the typed code.

fn from(err: AeronArchiveError) -> Self

Converts to this type from the input type.

impl From<AeronErrorType> for AeronCError

fn from(value: AeronErrorType) -> Self

Converts to this type from the input type.

impl PartialEq for AeronCError

Equality is on code only — the attached message is advisory.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for AeronCError