Struct AeronMappedBuffer 

pub struct AeronMappedBuffer { /* private fields */ }

Implementations

impl AeronMappedBuffer

pub fn new(addr: &mut [u8]) -> 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 addr(&self) -> &mut [u8]

pub fn length(&self) -> usize

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

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

impl AeronMappedBuffer

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 AeronMappedBuffer

fn clone(&self) -> AeronMappedBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AeronMappedBuffer

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

Formats the value using the given formatter.

impl Default for AeronMappedBuffer

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 AeronMappedBuffer

type Target = aeron_mapped_buffer_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronMappedBuffer> for *mut aeron_mapped_buffer_t

fn from(value: &AeronMappedBuffer) -> Self

Converts to this type from the input type.

impl From<*const aeron_mapped_buffer_stct> for AeronMappedBuffer

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

Converts to this type from the input type.

impl From<*mut aeron_mapped_buffer_stct> for AeronMappedBuffer

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

Converts to this type from the input type.

impl From<AeronMappedBuffer> for *mut aeron_mapped_buffer_t

fn from(value: AeronMappedBuffer) -> Self

Converts to this type from the input type.

impl From<AeronMappedBuffer> for aeron_mapped_buffer_t

fn from(value: AeronMappedBuffer) -> Self

Converts to this type from the input type.

impl From<aeron_mapped_buffer_stct> for AeronMappedBuffer

fn from(value: aeron_mapped_buffer_t) -> Self

Converts to this type from the input type.