Struct Message 

pub struct Message<T: ?Sized> { /* private fields */ }

An owned VPP message buffer containing a T.

The message can be sent to a client using Registration::send_message.

Important invariant:

• T must have an alignment of 1 (e.g. by #[repr(packed)])

Implementations

impl<T> Message<T>

pub fn new(value: T) -> Self

Allocate a VPP message and initialise it by copying value into the newly-allocated buffer.

Panics

Panics if align_of::<T>() != 1 because the VPP API message allocator does not provide alignment guarantees; generated message structs are expected to be packed.

pub fn new_uninit() -> Message<MaybeUninit<T>>

Allocate an uninitialised VPP message buffer for T.

This returns a Message<MaybeUninit<T>>. Use Self::write or Self::assume_init after manually initialising the contents.

Panics

Panics if align_of::<T>() != 1 for the same reason as new.

impl Message<u8>

pub fn new_bytes(nbytes: u32) -> Message<u8>

Allocate a VPP message buffer nbytes of u8s initialised to 0.

impl<T: ?Sized> Message<T>

pub fn into_raw(m: Self) -> *mut T

Consume the Message and return the raw pointer to the underlying buffer

The returned pointer becomes the caller’s responsibility. The Message destructor will not run for m and the underlying buffer will not be freed by Rust; callers must ensure the buffer is eventually freed (for example by passing it to VPP or calling vl_msg_api_free).

Not a method on Message to avoid clashing with application methods of the same name on the underlying type.

impl<T> Message<MaybeUninit<T>>

pub unsafe fn assume_init(self) -> Message<T>

Convert a Message<MaybeUninit<T>> into a Message<T> without performing any initialisation checks

Safety

The caller must ensure that the underlying buffer is fully initialised for T. If the memory is not properly initialised, using the resulting Message<T> is undefined behaviour.

pub fn write(self, value: T) -> Message<T>

Initialise the previously-uninitialised buffer with value and return the initialised Message<T>

Trait Implementations

impl<T: Debug + ?Sized> Debug for Message<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Message<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized> Deref for Message<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> DerefMut for Message<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Display + ?Sized> Display for Message<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for Message<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<T> for Message<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: ?Sized + Hash> Hash for Message<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: ?Sized + Ord> Ord for Message<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: ?Sized + PartialEq> PartialEq for Message<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: ?Sized + PartialOrd> PartialOrd for Message<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ?Sized> Pointer for Message<T>

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

Formats the value using the given formatter.

impl<T: ?Sized + Eq> Eq for Message<T>