Skip to main content

MessageHeader

Struct MessageHeader 

Source
pub struct MessageHeader {
    pub size: AtomicU32,
    /* private fields */
}
Expand description

Message header. size is the cross-thread control word (AtomicU32).

The header occupies exactly 8 bytes (one ring-buffer block). The payload immediately follows and stores:

[info_ptr: *const StaticInfo (8B)] [timestamp: i64 (8B)] [encoded args...]

Layout constants PAYLOAD_INFO_OFFSET, PAYLOAD_TIMESTAMP_OFFSET, PAYLOAD_ARGS_OFFSET, and PAYLOAD_HEADER_SIZE describe the payload structure.

Fields§

§size: AtomicU32

Total message size in bytes (header + payload), used as an atomic control word.

Implementations§

Source§

impl MessageHeader

Source

pub fn push(&self, payload_size: u32)

Publish a message: performs a Release store of the total size, making the payload visible to the consumer.

Source

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

Returns a pointer to the beginning of the payload (immediately after the header).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.