Struct AeronImageConstants

pub struct AeronImageConstants { /* private fields */ }

Configuration for an image that does not change during it’s lifetime.

Implementations

impl AeronImageConstants

pub fn new( subscription: &AeronSubscription, source_identity: &CStr, correlation_id: i64, join_position: i64, position_bits_to_shift: usize, term_buffer_length: usize, mtu_length: usize, session_id: i32, initial_term_id: i32, subscriber_position_id: 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 subscription(&self) -> AeronSubscription

pub fn source_identity(&self) -> &str

pub fn correlation_id(&self) -> i64

pub fn join_position(&self) -> i64

pub fn position_bits_to_shift(&self) -> usize

pub fn term_buffer_length(&self) -> usize

pub fn mtu_length(&self) -> usize

pub fn session_id(&self) -> i32

pub fn initial_term_id(&self) -> i32

pub fn subscriber_position_id(&self) -> i32

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

pub fn get_inner_mut(&self) -> &mut aeron_image_constants_t

pub fn get_inner_ref(&self) -> &aeron_image_constants_t

impl AeronImageConstants

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)

Trait Implementations

impl Clone for AeronImageConstants

fn clone(&self) -> AeronImageConstants

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AeronImageConstants

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

Formats the value using the given formatter.

impl Default for AeronImageConstants

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 AeronImageConstants

type Target = aeron_image_constants_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronImageConstants> for *mut aeron_image_constants_t

fn from(value: &AeronImageConstants) -> Self

Converts to this type from the input type.

impl From<*const aeron_image_constants_stct> for AeronImageConstants

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

Converts to this type from the input type.

impl From<*mut aeron_image_constants_stct> for AeronImageConstants

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

Converts to this type from the input type.

impl From<AeronImageConstants> for *mut aeron_image_constants_t

fn from(value: AeronImageConstants) -> Self

Converts to this type from the input type.

impl From<AeronImageConstants> for aeron_image_constants_t

fn from(value: AeronImageConstants) -> Self

Converts to this type from the input type.

impl From<aeron_image_constants_stct> for AeronImageConstants

fn from(value: aeron_image_constants_t) -> Self

Converts to this type from the input type.