pub struct AeronBufferClaim { /* private fields */ }Expand description
Structure used to hold information for a try_claim function call.
Implementations§
Source§impl AeronBufferClaim
impl AeronBufferClaim
pub fn new(frame_header: *mut u8, data: &mut [u8]) -> 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 frame_header(&self) -> *mut u8
pub fn data(&self) -> &mut [u8] ⓘ
pub fn length(&self) -> usize
Sourcepub fn commit(&self) -> Result<i32, AeronCError>
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.
Sourcepub fn abort(&self) -> Result<i32, AeronCError>
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
Sourcepub unsafe fn get_inner_mut(&self) -> &mut aeron_buffer_claim_t
pub unsafe fn get_inner_mut(&self) -> &mut aeron_buffer_claim_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_buffer_claim_t
Source§impl AeronBufferClaim
impl AeronBufferClaim
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
Source§impl AeronBufferClaim
impl AeronBufferClaim
Sourcepub fn data_mut(&mut self) -> &mut [u8] ⓘ
pub fn data_mut(&mut self) -> &mut [u8] ⓘ
The claimed bytes, to write into. Empty if the claim holds no buffer, for example one
from new_zeroed_on_heap or before a successful try_claim
Sourcepub fn frame_header_mut(&mut self) -> Option<&mut aeron_header_values_frame_t>
pub fn frame_header_mut(&mut self) -> Option<&mut aeron_header_values_frame_t>
The frame header of the claim, or None if the claim holds no buffer
Trait Implementations§
Source§impl Clone for AeronBufferClaim
impl Clone for AeronBufferClaim
Source§fn clone(&self) -> AeronBufferClaim
fn clone(&self) -> AeronBufferClaim
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 AeronBufferClaim
impl Debug for AeronBufferClaim
Source§impl Default for AeronBufferClaim
This will create an instance where the struct is zeroed, use with care
impl Default for AeronBufferClaim
This will create an instance where the struct is zeroed, use with care