Struct AeronHeader

pub struct AeronHeader { /* private fields */ }

Implementations

impl AeronHeader

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

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

pub fn values(&self, values: &AeronHeaderValues) -> Result<i32, AeronCError>

Get all of the field values from the header. This will do a memcpy into the supplied header_values_t pointer.

Parameters

• header to read values from.

• values to copy values to, must not be null.

Return

0 on success, -1 on failure.

pub fn get_values(&self) -> Result<AeronHeaderValues, AeronCError>

Get all of the field values from the header. This will do a memcpy into the supplied header_values_t pointer.

pub fn position(&self) -> i64

Get the current position to which the Image has advanced on reading this message.

Return

the current position to which the Image has advanced on reading this message.

pub fn position_bits_to_shift(&self) -> usize

Get the number of times to left shift the term count to multiply by term length.

Return

number of times to left shift the term count to multiply by term length.

pub fn next_term_offset(&self) -> i32

Calculates the offset of the frame immediately after this one.

Return

the offset of the next frame.

pub fn context(&self) -> *mut c_void

Get a pointer to the context associated with this message. Only valid during poll handling. Is normally a pointer to an Image instance.

Return

a pointer to the context associated with this message.

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

Trait Implementations

impl Clone for AeronHeader

fn clone(&self) -> AeronHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AeronHeader

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

Formats the value using the given formatter.

impl Deref for AeronHeader

type Target = aeron_header_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronHeader> for *mut aeron_header_t

fn from(value: &AeronHeader) -> Self

Converts to this type from the input type.

impl From<*const aeron_header_stct> for AeronHeader

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

Converts to this type from the input type.

impl From<*mut aeron_header_stct> for AeronHeader

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

Converts to this type from the input type.

impl From<AeronHeader> for *mut aeron_header_t

fn from(value: AeronHeader) -> Self

Converts to this type from the input type.

impl From<AeronHeader> for aeron_header_t

fn from(value: AeronHeader) -> Self

Converts to this type from the input type.

impl From<aeron_header_stct> for AeronHeader

fn from(value: aeron_header_t) -> Self

Converts to this type from the input type.