Struct AeronBroadcastReceiver

pub struct AeronBroadcastReceiver { /* private fields */ }

Implementations

impl AeronBroadcastReceiver

pub fn new( scratch_buffer: [u8; 4096], buffer: *mut u8, descriptor: &AeronBroadcastDescriptor, capacity: usize, mask: usize, record_offset: usize, cursor: i64, next_record: i64, lapped_count: c_long, ) -> Result<Self, AeronCError>

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

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

pub fn scratch_buffer(&self) -> [u8; 4096]

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

pub fn descriptor(&self) -> AeronBroadcastDescriptor

pub fn capacity(&self) -> usize

pub fn mask(&self) -> usize

pub fn record_offset(&self) -> usize

pub fn cursor(&self) -> i64

pub fn next_record(&self) -> i64

pub fn lapped_count(&self) -> c_long

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

pub fn receive<AeronBroadcastReceiverHandlerHandlerImpl: AeronBroadcastReceiverHandlerCallback>( &self, handler: Option<&Handler<AeronBroadcastReceiverHandlerHandlerImpl>>, ) -> Result<i32, AeronCError>

pub fn receive_once<AeronBroadcastReceiverHandlerHandlerImpl: FnMut(i32, &mut [u8])>( &self, handler: AeronBroadcastReceiverHandlerHandlerImpl, ) -> Result<i32, AeronCError>

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

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

impl AeronBroadcastReceiver

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 AeronBroadcastReceiver

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

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

impl AeronBroadcastReceiver

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

Trait Implementations

impl Clone for AeronBroadcastReceiver

fn clone(&self) -> AeronBroadcastReceiver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AeronBroadcastReceiver

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

Formats the value using the given formatter.

impl Default for AeronBroadcastReceiver

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 AeronBroadcastReceiver

type Target = aeron_broadcast_receiver_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronBroadcastReceiver> for *mut aeron_broadcast_receiver_t

fn from(value: &AeronBroadcastReceiver) -> Self

Converts to this type from the input type.

impl From<*const aeron_broadcast_receiver_stct> for AeronBroadcastReceiver

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

Converts to this type from the input type.

impl From<*mut aeron_broadcast_receiver_stct> for AeronBroadcastReceiver

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

Converts to this type from the input type.

impl From<AeronBroadcastReceiver> for *mut aeron_broadcast_receiver_t

fn from(value: AeronBroadcastReceiver) -> Self

Converts to this type from the input type.

impl From<AeronBroadcastReceiver> for aeron_broadcast_receiver_t

fn from(value: AeronBroadcastReceiver) -> Self

Converts to this type from the input type.

impl From<aeron_broadcast_receiver_stct> for AeronBroadcastReceiver

fn from(value: aeron_broadcast_receiver_t) -> Self

Converts to this type from the input type.

impl Send for AeronBroadcastReceiver