Struct vmm_vhost::message::VhostUserMsgHeader

#[repr(C, packed(1))]
pub struct VhostUserMsgHeader<R: Req> {
    request: u32,
    flags: u32,
    size: u32,
    _r: PhantomData<R>,
}

Common message header for vhost-user requests and replies. A vhost-user message consists of 3 header fields and an optional payload. All numbers are in the machine native byte order.

Fields

request: u32

flags: u32

size: u32

_r: PhantomData<R>

Implementations

impl<R: Req> VhostUserMsgHeader<R>

pub fn new(request: R, flags: u32, size: u32) -> Self

Create a new instance of VhostUserMsgHeader.

pub fn get_code(&self) -> Result<R, R::Error>

Get message type.

pub fn set_code(&mut self, request: R)

Set message type.

pub fn get_version(&self) -> u32

Get message version number.

pub fn set_version(&mut self, ver: u32)

Set message version number.

pub fn is_reply(&self) -> bool

Check whether it’s a reply message.

pub fn set_reply(&mut self, is_reply: bool)

Mark message as reply.

pub fn is_need_reply(&self) -> bool

Check whether reply for this message is requested.

pub fn set_need_reply(&mut self, need_reply: bool)

Mark that reply for this message is needed.

pub fn is_reply_for(&self, req: &VhostUserMsgHeader<R>) -> bool

Check whether it’s the reply message for the request req.

pub fn get_size(&self) -> u32

Get message size.

pub fn set_size(&mut self, size: u32)

Set message size.

Trait Implementations

impl<R: Req> AsBytes for VhostUserMsgHeader<R>

where u32: AsBytes, PhantomData<R>: AsBytes,

fn as_bytes(&self) -> &[u8]

Gets the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to bytes.

fn write_to_prefix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the prefix of bytes.

fn write_to_suffix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the suffix of bytes.

impl<R: Req> Clone for VhostUserMsgHeader<R>

fn clone(&self) -> VhostUserMsgHeader<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Req> Debug for VhostUserMsgHeader<R>

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

Formats the value using the given formatter.

impl<R: Req> Default for VhostUserMsgHeader<R>

fn default() -> Self

Returns the “default value” for a type.

impl<R: Req> FromBytes for VhostUserMsgHeader<R>

where u32: FromBytes, PhantomData<R>: FromBytes,

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

where Self: Sized,

Interprets the given bytes as a &Self without copying.

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

where Self: Sized,

Interprets the prefix of the given bytes as a &Self without copying.

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

where Self: Sized,

Interprets the suffix of the given bytes as a &Self without copying.

fn mut_from(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut Self without copying.

fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut Self without copying.

fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut Self without copying.

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

where Self: Sized,

Interprets the given bytes as a &[Self] without copying.

fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>

where Self: Sized,

Interprets the prefix of the given bytes as a &[Self] with length equal to count without copying.

fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>

where Self: Sized,

Interprets the suffix of the given bytes as a &[Self] with length equal to count without copying.

fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut [Self] without copying.

fn mut_slice_from_prefix( bytes: &mut [u8], count: usize ) -> Option<(&mut [Self], &mut [u8])>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut [Self] with length equal to count without copying.

fn mut_slice_from_suffix( bytes: &mut [u8], count: usize ) -> Option<(&mut [u8], &mut [Self])>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut [Self] with length equal to count without copying.

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

where Self: Sized,

Reads a copy of Self from bytes.

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

where Self: Sized,

Reads a copy of Self from the prefix of bytes.

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

where Self: Sized,

Reads a copy of Self from the suffix of bytes.

impl<R: Req> FromZeroes for VhostUserMsgHeader<R>

where u32: FromZeroes, PhantomData<R>: FromZeroes,

fn zero(&mut self)

Overwrites self with zeroes.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<R: Req> PartialEq for VhostUserMsgHeader<R>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Req> VhostUserMsgValidator for VhostUserMsgHeader<T>

fn is_valid(&self) -> bool

Validate message syntax only. It doesn’t validate message semantics such as protocol version number and dependency on feature flags etc.

impl<R: Copy + Req> Copy for VhostUserMsgHeader<R>