Struct abyss::dev::pci::virtio::VirtIoFeaturesCommon

pub struct VirtIoFeaturesCommon { /* private fields */ }

Implementations

impl VirtIoFeaturesCommon

pub const NOTIFY_ON_EMPTY: Self = _

If this feature has been negotiated by driver, the device MUST issue a used buffer notification if the device runs out of available descriptors on a virtqueue, even though notifications are suppressed using the VIRTQ_AVAIL_F_NO_INTERRUPT flag or the used_event field. Note: An example of a driver using this feature is the legacy networking driver: it doesn’t need to know every time a packet is transmitted, but it does need to free the transmitted packets a finite time after they are transmitted. It can avoid using a timer if the device notifies it when all the packets are transmitted.

pub const ANY_LAYOUT: Self = _

This feature indicates that the device accepts arbitrary descriptor layouts, as described in Section 2.6.4.3 Legacy Interface: Message Framing.

pub const RING_INDIRECT_DESC: Self = _

Negotiating this feature indicates that the driver can use descriptors with the VIRTQ_DESC_F_INDIRECT flag set, as described in 2.6.5.3 Indirect Descriptors and 2.7.7 Indirect Flag: Scatter-Gather Support.

pub const RING_EVENT_IDX: Self = _

This feature enables the used_event and the avail_event fields as described in 2.6.7, 2.6.8 and 2.7.10.

pub const VERSION_1: Self = _

This indicates compliance with this specification, giving a simple way to detect legacy devices or drivers.

pub const ACCESS_PLATFORM: Self = _

This feature indicates that the device can be used on a platform where device access to data in memory is limited and/or translated. E.g. this is the case if the device can be located behind an IOMMU that translates bus addresses from the device into physical addresses in memory, if the device can be limited to only access certain memory addresses or if special commands such as a cache flush can be needed to synchronise data in memory with the device. Whether accesses are actually limited or translated is described by platform-specific means. If this feature bit is set to 0, then the device has same access to memory addresses supplied to it as the driver has. In particular, the device will always use physical addresses matching addresses used by the driver (typically meaning physical addresses used by the CPU) and not translated further, and can access any address supplied to it by the driver. When clear, this overrides any platform-specific description of whether device access is limited or translated in any way, e.g. whether an IOMMU may be present.

pub const RING_PACKED: Self = _

This feature indicates support for the packed virtqueue layout as described in 2.7 Packed Virtqueues.

pub const IN_ORDER: Self = _

This feature indicates that all buffers are used by the device in the same order in which they have been made available.

pub const ORDER_PLATFORM: Self = _

This feature indicates that memory accesses by the driver and the device are ordered in a way described by the platform. If this feature bit is negotiated, the ordering in effect for any memory accesses by the driver that need to be ordered in a specific way with respect to accesses by the device is the one suitable for devices described by the platform. This implies that the driver needs to use memory barriers suitable for devices described by the platform; e.g. for the PCI transport in the case of hardware PCI devices. this feature bit is not negotiated, then the device and driver are assumed to be implemented in software, that is they can be assumed to run on identical CPUs in an SMP configuration. Thus a weaker form of memory barriers is sufficient to yield better performance.

pub const SR_IOV: Self = _

This feature indicates that the device supports Single Root I/O Virtualization. Currently only PCI devices support this feature.

pub const NOTRIFICATION_DATA: Self = _

This feature indicates that the driver passes extra data (besides identifying the virtqueue) in its device notifications. See 2.7.23 Driver notifications.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u64) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for VirtIoFeaturesCommon

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

Formats the value using the given formatter.

impl BitAnd<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

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

Returns the intersection between the two sets of flags.

type Output = VirtIoFeaturesCommon

The resulting type after applying the & operator.

impl BitAndAssign<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

fn bitor(self, other: VirtIoFeaturesCommon) -> Self

Returns the union of the two sets of flags.

type Output = VirtIoFeaturesCommon

The resulting type after applying the | operator.

impl BitOrAssign<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

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

Returns the left flags, but with all the right flags toggled.

type Output = VirtIoFeaturesCommon

The resulting type after applying the ^ operator.

impl BitXorAssign<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for VirtIoFeaturesCommon

fn clone(&self) -> VirtIoFeaturesCommon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtIoFeaturesCommon

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

Formats the value using the given formatter.

impl Extend<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for VirtIoFeaturesCommon

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 LowerHex for VirtIoFeaturesCommon

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

Formats the value using the given formatter.

impl Not for VirtIoFeaturesCommon

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = VirtIoFeaturesCommon

The resulting type after applying the ! operator.

impl Octal for VirtIoFeaturesCommon

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

Formats the value using the given formatter.

impl Ord for VirtIoFeaturesCommon

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

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

Returns the set difference of the two sets of flags.

type Output = VirtIoFeaturesCommon

The resulting type after applying the - operator.

impl SubAssign<VirtIoFeaturesCommon> for VirtIoFeaturesCommon

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for VirtIoFeaturesCommon

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

Formats the value using the given formatter.

impl Copy for VirtIoFeaturesCommon

impl Eq for VirtIoFeaturesCommon

impl StructuralEq for VirtIoFeaturesCommon

impl StructuralPartialEq for VirtIoFeaturesCommon