Struct AeronBufferClaim

pub struct AeronBufferClaim { /* private fields */ }

Structure used to hold information for a try_claim function call.

Implementations

impl AeronBufferClaim

pub fn new(frame_header: *mut u8, data: &mut [u8]) -> Result<Self, AeronCError>

pub fn new_zeroed() -> Result<Self, AeronCError>

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

pub fn frame_header(&self) -> *mut u8

pub fn data(&self) -> &mut [u8]

pub fn length(&self) -> usize

pub fn commit(&self) -> Result<i32, AeronCError>

Commit the given buffer_claim as a complete message available for consumption.

Return

0 for success or -1 for error.

pub fn abort(&self) -> Result<i32, AeronCError>

Abort the given buffer_claim and assign its position as padding.

Return

0 for success or -1 for error.

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

impl AeronBufferClaim

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 danagerous to use with Aeron/AeronContext/AeronPublication/AeronSubscription More intended for AeronArchiveRecordingDescriptor

impl AeronBufferClaim

pub fn data_mut(&self) -> &mut [u8]

pub fn frame_header_mut(&self) -> &mut aeron_header_values_frame_t

Trait Implementations

impl Clone for AeronBufferClaim

fn clone(&self) -> AeronBufferClaim

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AeronBufferClaim

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

Formats the value using the given formatter.

impl Default for AeronBufferClaim

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 AeronBufferClaim

type Target = aeron_buffer_claim_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronBufferClaim> for *mut aeron_buffer_claim_t

fn from(value: &AeronBufferClaim) -> Self

Converts to this type from the input type.

impl From<*const aeron_buffer_claim_stct> for AeronBufferClaim

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

Converts to this type from the input type.

impl From<*mut aeron_buffer_claim_stct> for AeronBufferClaim

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

Converts to this type from the input type.

impl From<AeronBufferClaim> for *mut aeron_buffer_claim_t

fn from(value: AeronBufferClaim) -> Self

Converts to this type from the input type.

impl From<AeronBufferClaim> for aeron_buffer_claim_t

fn from(value: AeronBufferClaim) -> Self

Converts to this type from the input type.

impl From<aeron_buffer_claim_stct> for AeronBufferClaim

fn from(value: aeron_buffer_claim_t) -> Self

Converts to this type from the input type.