pub struct AeronArchiveRecordingSignal { /* private fields */ }Expand description
Struct containing the details of a recording signal.
Implementations§
Source§impl AeronArchiveRecordingSignal
impl AeronArchiveRecordingSignal
pub fn new( control_session_id: i64, recording_id: i64, subscription_id: i64, position: i64, recording_signal_code: i32, ) -> Result<Self, AeronCError>
Sourcepub fn new_zeroed_on_heap() -> Self
pub fn new_zeroed_on_heap() -> Self
creates zeroed struct where the underlying c struct is on the heap
Sourcepub fn new_zeroed_on_stack() -> Self
pub fn new_zeroed_on_stack() -> Self
creates zeroed struct where the underlying c struct is on the stack (Use with care)
pub fn control_session_id(&self) -> i64
pub fn recording_id(&self) -> i64
pub fn subscription_id(&self) -> i64
pub fn position(&self) -> i64
pub fn recording_signal_code(&self) -> i32
pub fn get_inner(&self) -> *mut aeron_archive_recording_signal_t
Sourcepub unsafe fn get_inner_mut(&self) -> &mut aeron_archive_recording_signal_t
pub unsafe fn get_inner_mut(&self) -> &mut aeron_archive_recording_signal_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.
pub fn get_inner_ref(&self) -> &aeron_archive_recording_signal_t
Source§impl AeronArchiveRecordingSignal
impl AeronArchiveRecordingSignal
Sourcepub unsafe fn from_ptr(ptr: *mut aeron_archive_recording_signal_t) -> Self
pub unsafe fn from_ptr(ptr: *mut aeron_archive_recording_signal_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
Sourcepub unsafe fn clone_reference(&self) -> Self
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 AeronArchiveRecordingSignal
impl AeronArchiveRecordingSignal
Sourcepub fn clone_struct(&self) -> Self
pub 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
The struct holds no pointers, so the copy does not depend on the source
Source§impl AeronArchiveRecordingSignal
impl AeronArchiveRecordingSignal
Sourcepub fn signal(&self) -> Option<aeron_archive_client_recording_signal_t>
pub fn signal(&self) -> Option<aeron_archive_client_recording_signal_t>
Typed variant of Self::recording_signal_code: the wire signal as the
aeron_archive_client_recording_signal_t enum (START/STOP/EXTEND/REPLICATE/…),
or None for codes this client version does not know.
Trait Implementations§
Source§impl Debug for AeronArchiveRecordingSignal
impl Debug for AeronArchiveRecordingSignal
Source§impl Default for AeronArchiveRecordingSignal
This will create an instance where the struct is zeroed, use with care
impl Default for AeronArchiveRecordingSignal
This will create an instance where the struct is zeroed, use with care