Struct AeronSpscRb

pub struct AeronSpscRb { /* private fields */ }

Implementations

impl AeronSpscRb

pub fn new( buffer: *mut u8, descriptor: &AeronRbDescriptor, capacity: usize, max_message_length: usize, ) -> Result<Self, AeronCError>

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

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

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

pub fn descriptor(&self) -> AeronRbDescriptor

pub fn capacity(&self) -> usize

pub fn max_message_length(&self) -> usize

pub fn init( &self, buffer: *mut c_void, length: usize, ) -> Result<i32, AeronCError>

pub fn write( &self, msg_type_id: i32, msg: *const c_void, length: usize, ) -> aeron_rb_write_result_t

pub fn writev( &self, msg_type_id: i32, iov: *const iovec, iovcnt: c_int, ) -> aeron_rb_write_result_t

pub fn try_claim(&self, msg_type_id: i32, length: usize) -> i32

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

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

pub fn read<AeronRbHandlerHandlerImpl: AeronRbHandlerCallback>( &self, handler: Option<&Handler<AeronRbHandlerHandlerImpl>>, message_count_limit: usize, ) -> usize

pub fn read_once<AeronRbHandlerHandlerImpl: FnMut(i32, *const c_void, usize)>( &self, handler: AeronRbHandlerHandlerImpl, message_count_limit: usize, ) -> usize

NOTE: aeron must not store this closure and instead use it immediately. If not you will get undefined behaviour, use with care

pub fn controlled_read<AeronRbControlledHandlerHandlerImpl: AeronRbControlledHandlerCallback>( &self, handler: Option<&Handler<AeronRbControlledHandlerHandlerImpl>>, message_count_limit: usize, ) -> usize

pub fn controlled_read_once<AeronRbControlledHandlerHandlerImpl: FnMut(i32, *const c_void, usize) -> aeron_rb_read_action_t>( &self, handler: AeronRbControlledHandlerHandlerImpl, message_count_limit: usize, ) -> usize

NOTE: aeron must not store this closure and instead use it immediately. If not you will get undefined behaviour, use with care

pub fn next_correlation_id(&self) -> i64

pub fn consumer_heartbeat_time(&self, time_ms: i64)

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

impl AeronSpscRb

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 AeronSpscRb

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

pub fn buffer_at_mut(&self, idx: usize, len: usize) -> &mut [u8]

impl AeronSpscRb

pub fn try_claim_slice<'a>( &'a self, msg_type_id: i32, length: usize, ) -> Result<AeronSpscRbSlot<'a>, AeronCError>

pub fn from_slice( buffer: &mut [u8], max_msg_size: usize, ) -> Result<Self, AeronCError>

pub fn new_with_capacity( capacity: usize, max_msg_size: usize, ) -> Result<Self, AeronCError>

impl AeronSpscRb

pub fn read_msgs<T: AeronRingBufferHandlerCallback>( &self, handler: &Handler<AeronRingBufferHandlerWrapper<T>>, message_count_limit: usize, ) -> usize

pub fn controlled_read_msgs<T: AeronRingBufferControlledHandlerCallback>( &self, handler: &Handler<AeronRingBufferControlledHandlerWrapper<T>>, message_count_limit: usize, ) -> usize

Trait Implementations

impl Clone for AeronSpscRb

fn clone(&self) -> AeronSpscRb

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AeronSpscRb

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

Formats the value using the given formatter.

impl Default for AeronSpscRb

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 AeronSpscRb

type Target = aeron_spsc_rb_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronSpscRb> for *mut aeron_spsc_rb_t

fn from(value: &AeronSpscRb) -> Self

Converts to this type from the input type.

impl From<*const aeron_spsc_rb_stct> for AeronSpscRb

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

Converts to this type from the input type.

impl From<*mut aeron_spsc_rb_stct> for AeronSpscRb

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

Converts to this type from the input type.

impl From<AeronSpscRb> for *mut aeron_spsc_rb_t

fn from(value: AeronSpscRb) -> Self

Converts to this type from the input type.

impl From<AeronSpscRb> for aeron_spsc_rb_t

fn from(value: AeronSpscRb) -> Self

Converts to this type from the input type.

impl From<aeron_spsc_rb_stct> for AeronSpscRb

fn from(value: aeron_spsc_rb_t) -> Self

Converts to this type from the input type.

impl Send for AeronSpscRb

impl Sync for AeronSpscRb