Struct hvdef::hypercall::HypercallOutput

pub struct HypercallOutput(/* private fields */);

The hypercall output value returned to the guest.

Implementations

impl HypercallOutput

pub const fn new() -> Self

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u64) -> Self

Convert from bits.

pub const fn into_bits(self) -> u64

Convert into bits.

pub const fn call_status(&self) -> u16

The HV_STATUS returned by the hypervisor.

Bits: 0..16

pub const fn with_call_status(self, value: u16) -> Self

The HV_STATUS returned by the hypervisor.

Bits: 0..16

pub fn set_call_status(&mut self, value: u16)

The HV_STATUS returned by the hypervisor.

Bits: 0..16

pub const fn rsvd(&self) -> u16

Bits: 16..32

pub const fn with_rsvd(self, value: u16) -> Self

Bits: 16..32

pub fn set_rsvd(&mut self, value: u16)

Bits: 16..32

pub const fn elements_processed(&self) -> u16

Bits: 32..44

pub const fn with_elements_processed(self, value: u16) -> Self

Bits: 32..44

pub fn set_elements_processed(&mut self, value: u16)

Bits: 32..44

pub const fn rsvd2(&self) -> u32

Bits: 44..64

pub const fn with_rsvd2(self, value: u32) -> Self

Bits: 44..64

pub fn set_rsvd2(&mut self, value: u32)

Bits: 44..64

impl HypercallOutput

pub const SUCCESS: Self = _

A success output with zero elements processed.

pub fn result(&self) -> Result<(), HvError>

Trait Implementations

impl AsBytes for HypercallOutput

where u64: 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 Clone for HypercallOutput

fn clone(&self) -> HypercallOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HypercallOutput

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

Formats the value using the given formatter.

impl Default for HypercallOutput

fn default() -> Self

Returns the “default value” for a type.

impl From<HvError> for HypercallOutput

fn from(e: HvError) -> Self

Converts to this type from the input type.

impl From<HypercallOutput> for u64

fn from(v: HypercallOutput) -> u64

Converts to this type from the input type.

impl From<u64> for HypercallOutput

fn from(v: u64) -> Self

Converts to this type from the input type.

impl FromBytes for HypercallOutput

where u64: 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 FromZeroes for HypercallOutput

where u64: FromZeroes,

fn zero(&mut self)

Overwrites self with zeroes.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

fn new_box_zeroed() -> Box<Self>

where Self: Sized,

Creates a Box<Self> from zeroed bytes.

fn new_box_slice_zeroed(len: usize) -> Box<[Self]>

where Self: Sized,

Creates a Box<[Self]> (a boxed slice) from zeroed bytes.

fn new_vec_zeroed(len: usize) -> Vec<Self>

where Self: Sized,

Creates a Vec<Self> from zeroed bytes.

impl Copy for HypercallOutput