pub struct AeronDeque { /* private fields */ }Implementations§
Source§impl AeronDeque
impl AeronDeque
pub fn new( data: *mut u8, element_count: usize, element_size: usize, first_element: usize, last_element: usize, ) -> 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 data(&self) -> *mut u8
pub fn element_count(&self) -> usize
pub fn element_size(&self) -> usize
pub fn first_element(&self) -> usize
pub fn last_element(&self) -> usize
pub fn init( &self, initial_element_count: usize, element_size: usize, ) -> Result<i32, AeronCError>
Sourcepub fn add_last(&self, value: *mut c_void) -> Result<i32, AeronCError>
pub fn add_last(&self, value: *mut c_void) -> Result<i32, AeronCError>
Add value into the deque as the last element. Will memcpy into the deque from the void pointer provided using the specified element size. May need to allocate in order to increase the size of the dequeue.
Errors: ENOMEM if growing the array fails.
§Parameters
dequeto add the value too.valuevalue to be added.
§Return
0 on success, -1 on failure.
pub fn remove_first(&self, value: *mut c_void) -> Result<i32, AeronCError>
pub fn get_inner(&self) -> *mut aeron_deque_t
Sourcepub unsafe fn get_inner_mut(&self) -> &mut aeron_deque_t
pub unsafe fn get_inner_mut(&self) -> &mut aeron_deque_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_deque_t
Source§impl AeronDeque
impl AeronDeque
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 AeronDeque
impl Clone for AeronDeque
Source§fn clone(&self) -> AeronDeque
fn clone(&self) -> AeronDeque
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 AeronDeque
impl Debug for AeronDeque
Source§impl Default for AeronDeque
This will create an instance where the struct is zeroed, use with care
impl Default for AeronDeque
This will create an instance where the struct is zeroed, use with care