Skip to main content

MessageDescriptor

Struct MessageDescriptor 

Source
pub struct MessageDescriptor {
    pub region: RegionHandle,
    pub offset: u64,
    pub length: u32,
    /* private fields */
}
Expand description

A zero-copy message descriptor.

Instead of copying message data into the ring buffer, a descriptor references data in a shared region. The receiver reads directly from the shared region using the offset and length.

§TOCTOU Protection

Only Immutable or AppendOnly regions can use descriptors (ADR-087 Section 20.5). This prevents time-of-check-to-time-of-use attacks where a sender modifies shared data after the receiver reads the descriptor but before processing.

Fields§

§region: RegionHandle

Handle to the shared region containing the data.

§offset: u64

Byte offset within the region.

§length: u32

Length in bytes.

Implementations§

Source§

impl MessageDescriptor

Source

pub const SIZE: usize

Size of a descriptor in bytes.

Source

pub const fn new(region: RegionHandle, offset: u64, length: u32) -> Self

Create a new message descriptor.

Source

pub fn is_valid(&self) -> bool

Check if this descriptor is valid (non-null region, non-zero length).

Source

pub fn to_bytes(&self) -> [u8; 24]

Convert to bytes for storage in ring buffer.

Source

pub fn from_bytes(bytes: &[u8]) -> Option<Self>

Create from bytes read from ring buffer.

Trait Implementations§

Source§

impl Clone for MessageDescriptor

Source§

fn clone(&self) -> MessageDescriptor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MessageDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for MessageDescriptor

Source§

fn eq(&self, other: &MessageDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for MessageDescriptor

Source§

impl Eq for MessageDescriptor

Source§

impl StructuralPartialEq for MessageDescriptor

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.