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

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

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.