pub struct AeronImageConstants { /* private fields */ }Expand description
Configuration for an image that does not change during it’s lifetime.
Implementations§
Source§impl AeronImageConstants
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>
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 subscription(&self) -> Ref<'_, 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
Sourcepub unsafe fn get_inner_mut(&self) -> &mut aeron_image_constants_t
pub unsafe fn get_inner_mut(&self) -> &mut aeron_image_constants_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_image_constants_t
Source§impl AeronImageConstants
impl AeronImageConstants
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 Clone for AeronImageConstants
impl Clone for AeronImageConstants
Source§fn clone(&self) -> AeronImageConstants
fn clone(&self) -> AeronImageConstants
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for AeronImageConstants
impl Debug for AeronImageConstants
Source§impl Default for AeronImageConstants
This will create an instance where the struct is zeroed, use with care
impl Default for AeronImageConstants
This will create an instance where the struct is zeroed, use with care