pub struct AeronArchiveRecordingDescriptor { /* private fields */ }Expand description
Struct containing the details of a recording
Implementations§
Source§impl AeronArchiveRecordingDescriptor
impl AeronArchiveRecordingDescriptor
pub fn new( control_session_id: i64, correlation_id: i64, recording_id: i64, start_timestamp: i64, stop_timestamp: i64, start_position: i64, stop_position: i64, initial_term_id: i32, segment_file_length: i32, term_buffer_length: i32, mtu_length: i32, session_id: i32, stream_id: i32, stripped_channel: &mut [u8], original_channel: &mut [u8], source_identity: &mut [u8], ) -> 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 correlation_id(&self) -> i64
pub fn recording_id(&self) -> i64
pub fn start_timestamp(&self) -> i64
pub fn stop_timestamp(&self) -> i64
pub fn start_position(&self) -> i64
pub fn stop_position(&self) -> i64
pub fn initial_term_id(&self) -> i32
pub fn segment_file_length(&self) -> i32
pub fn term_buffer_length(&self) -> i32
pub fn mtu_length(&self) -> i32
pub fn session_id(&self) -> i32
pub fn stream_id(&self) -> i32
pub fn stripped_channel(&self) -> &str
pub fn stripped_channel_length(&self) -> usize
pub fn original_channel(&self) -> &str
pub fn original_channel_length(&self) -> usize
pub fn source_identity(&self) -> &str
pub fn source_identity_length(&self) -> usize
pub fn get_inner(&self) -> *mut aeron_archive_recording_descriptor_t
Sourcepub unsafe fn get_inner_mut(&self) -> &mut aeron_archive_recording_descriptor_t
pub unsafe fn get_inner_mut(&self) -> &mut aeron_archive_recording_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.
pub fn get_inner_ref(&self) -> &aeron_archive_recording_descriptor_t
Source§impl AeronArchiveRecordingDescriptor
impl AeronArchiveRecordingDescriptor
Sourcepub unsafe fn from_ptr(ptr: *mut aeron_archive_recording_descriptor_t) -> Self
pub unsafe fn from_ptr(ptr: *mut aeron_archive_recording_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
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 AeronArchiveRecordingDescriptor
impl AeronArchiveRecordingDescriptor
Sourcepub unsafe fn clone_struct(&self) -> Self
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 Default for AeronArchiveRecordingDescriptor
This will create an instance where the struct is zeroed, use with care
impl Default for AeronArchiveRecordingDescriptor
This will create an instance where the struct is zeroed, use with care