Skip to main content

AeronArchiveRecordingSubscriptionDescriptor

Struct AeronArchiveRecordingSubscriptionDescriptor 

Source
pub struct AeronArchiveRecordingSubscriptionDescriptor { /* private fields */ }
Expand description

Struct containing the details of a recording subscription

Implementations§

Source§

impl AeronArchiveRecordingSubscriptionDescriptor

Source

pub fn new( control_session_id: i64, correlation_id: i64, subscription_id: i64, stream_id: i32, stripped_channel: &mut [u8], ) -> Result<Self, AeronCError>

Source

pub fn new_zeroed_on_heap() -> Self

creates zeroed struct where the underlying c struct is on the heap

Source

pub fn new_zeroed_on_stack() -> Self

creates zeroed struct where the underlying c struct is on the stack (Use with care)

Source

pub fn control_session_id(&self) -> i64

Source

pub fn correlation_id(&self) -> i64

Source

pub fn subscription_id(&self) -> i64

Source

pub fn stream_id(&self) -> i32

Source

pub fn stripped_channel(&self) -> &str

Source

pub fn stripped_channel_length(&self) -> usize

Source

pub fn get_inner( &self, ) -> *mut aeron_archive_recording_subscription_descriptor_t

Source

pub unsafe fn get_inner_mut( &self, ) -> &mut aeron_archive_recording_subscription_descriptor_t

Mutable access to the underlying C struct, minted from &self: nothing prevents two live &mut at once, so the caller must ensure exclusive access for the lifetime of the returned reference.

§Safety

No other reference (& or &mut) to the underlying struct may be alive while the returned &mut is in use.

Source

pub fn get_inner_ref( &self, ) -> &aeron_archive_recording_subscription_descriptor_t

Source§

impl AeronArchiveRecordingSubscriptionDescriptor

Source

pub unsafe fn from_ptr( ptr: *mut aeron_archive_recording_subscription_descriptor_t, ) -> Self

Wraps a pointer to a struct Aeron passes to a callback, without copying it

§Safety

ptr must point at a valid struct for as long as the result is used. For a callback argument that is until the callback returns

Source

pub unsafe fn clone_reference(&self) -> Self

Returns a second handle to the same underlying struct, without copying it. If owned on heap both handles share it; if borrowed, e.g. a callback argument, both point at the same C memory

§Safety

A callback argument lives in memory Aeron frees or reuses when the callback returns, so do not use the returned handle after that. Copy out the fields you need instead

Source§

impl AeronArchiveRecordingSubscriptionDescriptor

Source

pub unsafe fn clone_struct(&self) -> Self

Copies the underlying struct into a new heap allocation

Only for plain data structs with no init or clean-up functions, so not for Aeron, AeronContext, AeronPublication or AeronSubscription

§Safety

Number fields are copied, but pointer fields (strings, buffers, other structs) still point at the source’s memory. Do not read them, including via Debug, once that memory is freed. For a callback argument that is when the callback returns. Copy strings out with .to_owned() instead

Trait Implementations§

Source§

impl Debug for AeronArchiveRecordingSubscriptionDescriptor

Source§

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

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

impl Default for AeronArchiveRecordingSubscriptionDescriptor

This will create an instance where the struct is zeroed, use with care

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Deref for AeronArchiveRecordingSubscriptionDescriptor

Source§

type Target = aeron_archive_recording_subscription_descriptor_stct

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl From<&AeronArchiveRecordingSubscriptionDescriptor> for *mut aeron_archive_recording_subscription_descriptor_t

Source§

fn from(value: &AeronArchiveRecordingSubscriptionDescriptor) -> Self

Converts to this type from the input type.
Source§

impl From<AeronArchiveRecordingSubscriptionDescriptor> for *mut aeron_archive_recording_subscription_descriptor_t

Source§

fn from(value: AeronArchiveRecordingSubscriptionDescriptor) -> Self

Converts to this type from the input type.
Source§

impl From<AeronArchiveRecordingSubscriptionDescriptor> for aeron_archive_recording_subscription_descriptor_t

Source§

fn from(value: AeronArchiveRecordingSubscriptionDescriptor) -> Self

Converts to this type from the input type.

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> 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.