Skip to main content

AeronOfferError

Enum AeronOfferError 

Source
pub enum AeronOfferError {
    NotConnected,
    BackPressured,
    AdminAction,
    Closed,
    MaxPositionExceeded,
    TooManyParts,
    Error(AeronCError),
}
Expand description

Typed error for offer / try_claim on a publication.

Aeron returns a negative sentinel instead of a stream position. These are not errno-style codes — -1 here means “not connected”, not a generic error — hence this dedicated type. Use Self::is_retryable to drive retry loops.

Variants§

§

NotConnected

No subscriber is connected (-1). Usually transient: a subscriber may connect later. Retryable.

§

BackPressured

Flow control or a full term buffer is applying back pressure (-2). Retry after idling. Retryable.

§

AdminAction

An administrative action (e.g. term rotation) is in progress (-3). Retry immediately. Retryable.

§

Closed

The publication is closed (-4). Fatal for this handle.

§

MaxPositionExceeded

The maximum stream position was reached (-5). Fatal: a new publication (new session) is required.

§

TooManyParts

More than [MAX_OFFER_PARTS] buffers passed to offer_parts — a caller bug, not an Aeron wire error. Fatal (fix the call site).

§

Error(AeronCError)

Any other negative value (-6 / unexpected). Fatal; inspect the inner AeronCError and Aeron::errmsg() for detail.

Implementations§

Source§

impl AeronOfferError

Source

pub fn from_position(position: i64) -> Result<i64, Self>

Maps a raw offer/try_claim return to Ok(position) or a typed error.

Source

pub fn is_retryable(&self) -> bool

A retry (possibly after idling / waiting for a subscriber) can succeed.

Source

pub fn is_fatal(&self) -> bool

The publication will never accept this offer again; recreate or give up.

Trait Implementations§

Source§

impl Clone for AeronOfferError

Source§

fn clone(&self) -> AeronOfferError

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 AeronOfferError

Source§

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

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

impl Display for AeronOfferError

Source§

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

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

impl Eq for AeronOfferError

Source§

impl Error for AeronOfferError

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 AeronOfferError

Source§

fn eq(&self, other: &AeronOfferError) -> 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 AeronOfferError

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<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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.