Struct AeronSetupHeader 

pub struct AeronSetupHeader { /* private fields */ }

Implementations

impl AeronSetupHeader

pub fn new( frame_header: AeronFrameHeader, term_offset: i32, session_id: i32, stream_id: i32, initial_term_id: i32, active_term_id: i32, term_length: i32, mtu: i32, ttl: 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 frame_header(&self) -> AeronFrameHeader

pub fn term_offset(&self) -> i32

pub fn session_id(&self) -> i32

pub fn stream_id(&self) -> i32

pub fn initial_term_id(&self) -> i32

pub fn active_term_id(&self) -> i32

pub fn term_length(&self) -> i32

pub fn mtu(&self) -> i32

pub fn ttl(&self) -> i32

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

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

impl AeronSetupHeader

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 AeronSetupHeader

fn clone(&self) -> AeronSetupHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AeronSetupHeader

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

Formats the value using the given formatter.

impl Default for AeronSetupHeader

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 AeronSetupHeader

type Target = aeron_setup_header_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronSetupHeader> for *mut aeron_setup_header_t

fn from(value: &AeronSetupHeader) -> Self

Converts to this type from the input type.

impl From<*const aeron_setup_header_stct> for AeronSetupHeader

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

Converts to this type from the input type.

impl From<*mut aeron_setup_header_stct> for AeronSetupHeader

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

Converts to this type from the input type.

impl From<AeronSetupHeader> for *mut aeron_setup_header_t

fn from(value: AeronSetupHeader) -> Self

Converts to this type from the input type.

impl From<AeronSetupHeader> for aeron_setup_header_t

fn from(value: AeronSetupHeader) -> Self

Converts to this type from the input type.

impl From<aeron_setup_header_stct> for AeronSetupHeader

fn from(value: aeron_setup_header_t) -> Self

Converts to this type from the input type.