Struct AeronCncMetadata 

pub struct AeronCncMetadata { /* private fields */ }

Implementations

impl AeronCncMetadata

pub fn new( cnc_version: i32, to_driver_buffer_length: i32, to_clients_buffer_length: i32, counter_metadata_buffer_length: i32, counter_values_buffer_length: i32, error_log_buffer_length: i32, client_liveness_timeout: i64, start_timestamp: i64, pid: i64, file_page_size: i32, ) -> Result<Self, AeronCError>

pub fn new_zeroed_on_heap() -> Self

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

pub fn new_zeroed_on_stack() -> Self

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

pub fn cnc_version(&self) -> i32

pub fn to_driver_buffer_length(&self) -> i32

pub fn to_clients_buffer_length(&self) -> i32

pub fn counter_metadata_buffer_length(&self) -> i32

pub fn counter_values_buffer_length(&self) -> i32

pub fn error_log_buffer_length(&self) -> i32

pub fn client_liveness_timeout(&self) -> i64

pub fn start_timestamp(&self) -> i64

pub fn pid(&self) -> i64

pub fn file_page_size(&self) -> i32

pub fn aeron_cnc_version_volatile(&self) -> i32

pub fn get_inner(&self) -> *mut aeron_cnc_metadata_t

pub unsafe fn get_inner_mut(&self) -> &mut aeron_cnc_metadata_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_cnc_metadata_t

impl AeronCncMetadata

pub fn clone_struct(&self) -> Self

Regular clone just increases the reference count of underlying count. clone_struct shallow copies the content of the underlying struct on heap.

NOTE: if the struct has references to other structs these will not be copied

Must be only used on structs which has no init/clean up methods. So its dangerous to use with Aeron/AeronContext/AeronPublication/AeronSubscription More intended for AeronArchiveRecordingDescriptor (note strings will not work as its a shallow copy)

impl AeronCncMetadata

pub fn load_from_file(aeron_dir: &str) -> Result<Self, AeronCError>

allocates on heap

pub fn read_from_file( aeron_dir: &CString, handler: impl FnMut(Self), ) -> Result<(), AeronCError>

allocates on stack

Trait Implementations

impl Clone for AeronCncMetadata

fn clone(&self) -> AeronCncMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AeronCncMetadata

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

Formats the value using the given formatter.

impl Default for AeronCncMetadata

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

fn default() -> Self

Returns the “default value” for a type.

impl Deref for AeronCncMetadata

type Target = aeron_cnc_metadata_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronCncMetadata> for *mut aeron_cnc_metadata_t

fn from(value: &AeronCncMetadata) -> Self

Converts to this type from the input type.

impl From<*const aeron_cnc_metadata_stct> for AeronCncMetadata

fn from(value: *const aeron_cnc_metadata_t) -> Self

Converts to this type from the input type.

impl From<*mut aeron_cnc_metadata_stct> for AeronCncMetadata

fn from(value: *mut aeron_cnc_metadata_t) -> Self

Converts to this type from the input type.

impl From<AeronCncMetadata> for *mut aeron_cnc_metadata_t

fn from(value: AeronCncMetadata) -> Self

Converts to this type from the input type.

impl From<AeronCncMetadata> for aeron_cnc_metadata_t

fn from(value: AeronCncMetadata) -> Self

Converts to this type from the input type.

impl From<aeron_cnc_metadata_stct> for AeronCncMetadata

fn from(value: aeron_cnc_metadata_t) -> Self

Converts to this type from the input type.