Struct FeatureFlags

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

Implementations

impl FeatureFlags

pub const fn new() -> Self

Creates a new default initialized bitfield.

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

Convert from bits.

pub const fn into_bits(self) -> u32

Convert into bits.

pub const fn guest_specified_signal_parameters(&self) -> bool

Feature which allows the guest to specify an event flag and connection ID when opening a channel. If not used, the event flag defaults to the channel ID and the connection ID is specified by the host in the offer channel message.

Bits: 0..1

pub const fn with_guest_specified_signal_parameters_checked( self, value: bool, ) -> Result<Self, ()>

Feature which allows the guest to specify an event flag and connection ID when opening a channel. If not used, the event flag defaults to the channel ID and the connection ID is specified by the host in the offer channel message.

Bits: 0..1

pub const fn with_guest_specified_signal_parameters(self, value: bool) -> Self

Feature which allows the guest to specify an event flag and connection ID when opening a channel. If not used, the event flag defaults to the channel ID and the connection ID is specified by the host in the offer channel message.

Bits: 0..1

pub const fn set_guest_specified_signal_parameters(&mut self, value: bool)

Feature which allows the guest to specify an event flag and connection ID when opening a channel. If not used, the event flag defaults to the channel ID and the connection ID is specified by the host in the offer channel message.

Bits: 0..1

pub const fn set_guest_specified_signal_parameters_checked( &mut self, value: bool, ) -> Result<(), ()>

Feature which allows the guest to specify an event flag and connection ID when opening a channel. If not used, the event flag defaults to the channel ID and the connection ID is specified by the host in the offer channel message.

Bits: 0..1

pub const fn channel_interrupt_redirection(&self) -> bool

Indicates the REDIRECT_INTERRUPT flag is supported in the OpenChannel flags.

Bits: 1..2

pub const fn with_channel_interrupt_redirection_checked( self, value: bool, ) -> Result<Self, ()>

Indicates the REDIRECT_INTERRUPT flag is supported in the OpenChannel flags.

Bits: 1..2

pub const fn with_channel_interrupt_redirection(self, value: bool) -> Self

Indicates the REDIRECT_INTERRUPT flag is supported in the OpenChannel flags.

Bits: 1..2

pub const fn set_channel_interrupt_redirection(&mut self, value: bool)

Indicates the REDIRECT_INTERRUPT flag is supported in the OpenChannel flags.

Bits: 1..2

pub const fn set_channel_interrupt_redirection_checked( &mut self, value: bool, ) -> Result<(), ()>

Indicates the REDIRECT_INTERRUPT flag is supported in the OpenChannel flags.

Bits: 1..2

pub const fn modify_connection(&self) -> bool

Indicates the MODIFY_CONNECTION and MODIFY_CONNECTION_RESPONSE messages are supported.

Bits: 2..3

pub const fn with_modify_connection_checked( self, value: bool, ) -> Result<Self, ()>

Indicates the MODIFY_CONNECTION and MODIFY_CONNECTION_RESPONSE messages are supported.

Bits: 2..3

pub const fn with_modify_connection(self, value: bool) -> Self

Indicates the MODIFY_CONNECTION and MODIFY_CONNECTION_RESPONSE messages are supported.

Bits: 2..3

pub const fn set_modify_connection(&mut self, value: bool)

Indicates the MODIFY_CONNECTION and MODIFY_CONNECTION_RESPONSE messages are supported.

Bits: 2..3

pub const fn set_modify_connection_checked( &mut self, value: bool, ) -> Result<(), ()>

Indicates the MODIFY_CONNECTION and MODIFY_CONNECTION_RESPONSE messages are supported.

Bits: 2..3

pub const fn client_id(&self) -> bool

Feature which allows a client (Windows, Linux, MiniVMBus, etc) to specify a well-known GUID to identify itself when initiating contact. If not used, the client ID is zero.

Bits: 3..4

pub const fn with_client_id_checked(self, value: bool) -> Result<Self, ()>

Feature which allows a client (Windows, Linux, MiniVMBus, etc) to specify a well-known GUID to identify itself when initiating contact. If not used, the client ID is zero.

Bits: 3..4

pub const fn with_client_id(self, value: bool) -> Self

Feature which allows a client (Windows, Linux, MiniVMBus, etc) to specify a well-known GUID to identify itself when initiating contact. If not used, the client ID is zero.

Bits: 3..4

pub const fn set_client_id(&mut self, value: bool)

Feature which allows a client (Windows, Linux, MiniVMBus, etc) to specify a well-known GUID to identify itself when initiating contact. If not used, the client ID is zero.

Bits: 3..4

pub const fn set_client_id_checked(&mut self, value: bool) -> Result<(), ()>

Feature which allows a client (Windows, Linux, MiniVMBus, etc) to specify a well-known GUID to identify itself when initiating contact. If not used, the client ID is zero.

Bits: 3..4

pub const fn confidential_channels(&self) -> bool

Indicates the confidential_ring_buffer and confidential_external_memory offer flags are supported.

Bits: 4..5

pub const fn with_confidential_channels_checked( self, value: bool, ) -> Result<Self, ()>

Indicates the confidential_ring_buffer and confidential_external_memory offer flags are supported.

Bits: 4..5

pub const fn with_confidential_channels(self, value: bool) -> Self

Indicates the confidential_ring_buffer and confidential_external_memory offer flags are supported.

Bits: 4..5

pub const fn set_confidential_channels(&mut self, value: bool)

Indicates the confidential_ring_buffer and confidential_external_memory offer flags are supported.

Bits: 4..5

pub const fn set_confidential_channels_checked( &mut self, value: bool, ) -> Result<(), ()>

Indicates the confidential_ring_buffer and confidential_external_memory offer flags are supported.

Bits: 4..5

pub const fn pause_resume(&self) -> bool

The server supports messages to pause and resume additional control messages.

Bits: 5..6

pub const fn with_pause_resume_checked(self, value: bool) -> Result<Self, ()>

The server supports messages to pause and resume additional control messages.

Bits: 5..6

pub const fn with_pause_resume(self, value: bool) -> Self

The server supports messages to pause and resume additional control messages.

Bits: 5..6

pub const fn set_pause_resume(&mut self, value: bool)

The server supports messages to pause and resume additional control messages.

Bits: 5..6

pub const fn set_pause_resume_checked(&mut self, value: bool) -> Result<(), ()>

The server supports messages to pause and resume additional control messages.

Bits: 5..6

pub const fn server_specified_monitor_pages(&self) -> bool

The guest supports having the server (host or paravisor) provide monitor page GPAs.

If this flag is present in the InitiateContact message, the guest may still provide its own monitor pages, which the server may ignore if it supports the flag. The server will only set this flag in the VersionResponse message if it is actually providing monitor pages, which the guest must then use instead of its own.

If the server sets the flag in the VersionResponse message, it must provide a non-zero value for the VersionResponse3::child_to_parent_monitor_page_gpa; the VersionResponse3::parent_to_child_monitor_page_gpa is optional and may be zero, in which case the guest cannot cancel MNF interrupts from the host.

Bits: 6..7

pub const fn with_server_specified_monitor_pages_checked( self, value: bool, ) -> Result<Self, ()>

The guest supports having the server (host or paravisor) provide monitor page GPAs.

If this flag is present in the InitiateContact message, the guest may still provide its own monitor pages, which the server may ignore if it supports the flag. The server will only set this flag in the VersionResponse message if it is actually providing monitor pages, which the guest must then use instead of its own.

If the server sets the flag in the VersionResponse message, it must provide a non-zero value for the VersionResponse3::child_to_parent_monitor_page_gpa; the VersionResponse3::parent_to_child_monitor_page_gpa is optional and may be zero, in which case the guest cannot cancel MNF interrupts from the host.

Bits: 6..7

pub const fn with_server_specified_monitor_pages(self, value: bool) -> Self

The guest supports having the server (host or paravisor) provide monitor page GPAs.

If this flag is present in the InitiateContact message, the guest may still provide its own monitor pages, which the server may ignore if it supports the flag. The server will only set this flag in the VersionResponse message if it is actually providing monitor pages, which the guest must then use instead of its own.

If the server sets the flag in the VersionResponse message, it must provide a non-zero value for the VersionResponse3::child_to_parent_monitor_page_gpa; the VersionResponse3::parent_to_child_monitor_page_gpa is optional and may be zero, in which case the guest cannot cancel MNF interrupts from the host.

Bits: 6..7

pub const fn set_server_specified_monitor_pages(&mut self, value: bool)

The guest supports having the server (host or paravisor) provide monitor page GPAs.

If this flag is present in the InitiateContact message, the guest may still provide its own monitor pages, which the server may ignore if it supports the flag. The server will only set this flag in the VersionResponse message if it is actually providing monitor pages, which the guest must then use instead of its own.

If the server sets the flag in the VersionResponse message, it must provide a non-zero value for the VersionResponse3::child_to_parent_monitor_page_gpa; the VersionResponse3::parent_to_child_monitor_page_gpa is optional and may be zero, in which case the guest cannot cancel MNF interrupts from the host.

Bits: 6..7

pub const fn set_server_specified_monitor_pages_checked( &mut self, value: bool, ) -> Result<(), ()>

The guest supports having the server (host or paravisor) provide monitor page GPAs.

If this flag is present in the InitiateContact message, the guest may still provide its own monitor pages, which the server may ignore if it supports the flag. The server will only set this flag in the VersionResponse message if it is actually providing monitor pages, which the guest must then use instead of its own.

If the server sets the flag in the VersionResponse message, it must provide a non-zero value for the VersionResponse3::child_to_parent_monitor_page_gpa; the VersionResponse3::parent_to_child_monitor_page_gpa is optional and may be zero, in which case the guest cannot cancel MNF interrupts from the host.

Bits: 6..7

impl FeatureFlags

pub fn contains(&self, other: FeatureFlags) -> bool

Returns true if other contains only flags that are also set in self.

Trait Implementations

impl BitAnd for FeatureFlags

type Output = FeatureFlags

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for FeatureFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for FeatureFlags

type Output = FeatureFlags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl Clone for FeatureFlags

fn clone(&self) -> FeatureFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeatureFlags

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

Formats the value using the given formatter.

impl Default for FeatureFlags

fn default() -> Self

Returns the “default value” for a type.

impl From<FeatureFlags> for u32

fn from(v: FeatureFlags) -> u32

Converts to this type from the input type.

impl From<u32> for FeatureFlags

fn from(v: u32) -> Self

Converts to this type from the input type.

impl FromBytes for FeatureFlags

where u32: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

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

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

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

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

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

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

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

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for FeatureFlags

where u32: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

fn new_box_zeroed() -> Result<Box<Self>, AllocError>

where Self: Sized,

Creates a Box<Self> from zeroed bytes.

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

where Self: Sized,

Creates a Vec<Self> from zeroed bytes.

fn extend_vec_zeroed( v: &mut Vec<Self>, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Extends a Vec<Self> by pushing additional new items onto the end of the vector. The new items are initialized with zeros.

fn insert_vec_zeroed( v: &mut Vec<Self>, position: usize, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Inserts additional new items into Vec<Self> at position. The new items are initialized with zeros.

impl Inspect for FeatureFlags

fn inspect(&self, req: Request<'_>)

Inspects the object.

impl IntoBytes for FeatureFlags

where u32: IntoBytes,

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

where Self: Immutable,

Gets the bytes of this value.

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

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl KnownLayout for FeatureFlags

where Self: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

impl PartialEq for FeatureFlags

fn eq(&self, other: &FeatureFlags) -> 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 TryFromBytes for FeatureFlags

where u32: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Copy for FeatureFlags

impl Eq for FeatureFlags

impl Immutable for FeatureFlags

where u32: Immutable,

impl StructuralPartialEq for FeatureFlags