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 into_raw(self) -> [u32; 3]

pub fn from_raw(raw: [u32; 3]) -> Self

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> 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> 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>