pub struct DeviceFormat { /* private fields */ }
Expand description
Architecture specific sample type.
Implementations§
Source§impl DeviceFormat
impl DeviceFormat
pub const S16LE: DeviceFormat
pub const S16BE: DeviceFormat
pub const F32LE: DeviceFormat
pub const F32BE: DeviceFormat
Sourcepub const fn empty() -> DeviceFormat
pub const fn empty() -> DeviceFormat
Returns an empty set of flags.
Sourcepub const fn all() -> DeviceFormat
pub const fn all() -> DeviceFormat
Returns the set containing all flags.
Sourcepub const fn from_bits(bits: u32) -> Option<DeviceFormat>
pub const fn from_bits(bits: u32) -> Option<DeviceFormat>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
Sourcepub const fn from_bits_truncate(bits: u32) -> DeviceFormat
pub const fn from_bits_truncate(bits: u32) -> DeviceFormat
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> DeviceFormat
pub const unsafe fn from_bits_unchecked(bits: u32) -> DeviceFormat
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.
Sourcepub const fn intersects(&self, other: DeviceFormat) -> bool
pub const fn intersects(&self, other: DeviceFormat) -> bool
Returns true
if there are flags common to both self
and other
.
Sourcepub const fn contains(&self, other: DeviceFormat) -> bool
pub const fn contains(&self, other: DeviceFormat) -> bool
Returns true
if all of the flags in other
are contained within self
.
Sourcepub fn insert(&mut self, other: DeviceFormat)
pub fn insert(&mut self, other: DeviceFormat)
Inserts the specified flags in-place.
Sourcepub fn remove(&mut self, other: DeviceFormat)
pub fn remove(&mut self, other: DeviceFormat)
Removes the specified flags in-place.
Sourcepub fn toggle(&mut self, other: DeviceFormat)
pub fn toggle(&mut self, other: DeviceFormat)
Toggles the specified flags in-place.
Sourcepub fn set(&mut self, other: DeviceFormat, value: bool)
pub fn set(&mut self, other: DeviceFormat, value: bool)
Inserts or removes the specified flags depending on the passed value.
Sourcepub const fn intersection(self, other: DeviceFormat) -> DeviceFormat
pub const fn intersection(self, other: DeviceFormat) -> DeviceFormat
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
.
Sourcepub const fn union(self, other: DeviceFormat) -> DeviceFormat
pub const fn union(self, other: DeviceFormat) -> DeviceFormat
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
.
Sourcepub const fn difference(self, other: DeviceFormat) -> DeviceFormat
pub const fn difference(self, other: DeviceFormat) -> DeviceFormat
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
.
Sourcepub const fn symmetric_difference(self, other: DeviceFormat) -> DeviceFormat
pub const fn symmetric_difference(self, other: DeviceFormat) -> DeviceFormat
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
.
Sourcepub const fn complement(self) -> DeviceFormat
pub const fn complement(self) -> DeviceFormat
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§
Source§impl Binary for DeviceFormat
impl Binary for DeviceFormat
Source§impl BitAnd for DeviceFormat
impl BitAnd for DeviceFormat
Source§fn bitand(self, other: DeviceFormat) -> DeviceFormat
fn bitand(self, other: DeviceFormat) -> DeviceFormat
Returns the intersection between the two sets of flags.
Source§type Output = DeviceFormat
type Output = DeviceFormat
&
operator.Source§impl BitAndAssign for DeviceFormat
impl BitAndAssign for DeviceFormat
Source§fn bitand_assign(&mut self, other: DeviceFormat)
fn bitand_assign(&mut self, other: DeviceFormat)
Disables all flags disabled in the set.
Source§impl BitOr for DeviceFormat
impl BitOr for DeviceFormat
Source§fn bitor(self, other: DeviceFormat) -> DeviceFormat
fn bitor(self, other: DeviceFormat) -> DeviceFormat
Returns the union of the two sets of flags.
Source§type Output = DeviceFormat
type Output = DeviceFormat
|
operator.Source§impl BitOrAssign for DeviceFormat
impl BitOrAssign for DeviceFormat
Source§fn bitor_assign(&mut self, other: DeviceFormat)
fn bitor_assign(&mut self, other: DeviceFormat)
Adds the set of flags.
Source§impl BitXor for DeviceFormat
impl BitXor for DeviceFormat
Source§fn bitxor(self, other: DeviceFormat) -> DeviceFormat
fn bitxor(self, other: DeviceFormat) -> DeviceFormat
Returns the left flags, but with all the right flags toggled.
Source§type Output = DeviceFormat
type Output = DeviceFormat
^
operator.Source§impl BitXorAssign for DeviceFormat
impl BitXorAssign for DeviceFormat
Source§fn bitxor_assign(&mut self, other: DeviceFormat)
fn bitxor_assign(&mut self, other: DeviceFormat)
Toggles the set of flags.
Source§impl Clone for DeviceFormat
impl Clone for DeviceFormat
Source§fn clone(&self) -> DeviceFormat
fn clone(&self) -> DeviceFormat
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DeviceFormat
impl Debug for DeviceFormat
Source§impl Extend<DeviceFormat> for DeviceFormat
impl Extend<DeviceFormat> for DeviceFormat
Source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = DeviceFormat>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = DeviceFormat>,
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Source§impl FromIterator<DeviceFormat> for DeviceFormat
impl FromIterator<DeviceFormat> for DeviceFormat
Source§fn from_iter<T>(iterator: T) -> DeviceFormatwhere
T: IntoIterator<Item = DeviceFormat>,
fn from_iter<T>(iterator: T) -> DeviceFormatwhere
T: IntoIterator<Item = DeviceFormat>,
Source§impl Hash for DeviceFormat
impl Hash for DeviceFormat
Source§impl LowerHex for DeviceFormat
impl LowerHex for DeviceFormat
Source§impl Not for DeviceFormat
impl Not for DeviceFormat
Source§fn not(self) -> DeviceFormat
fn not(self) -> DeviceFormat
Returns the complement of this set of flags.
Source§type Output = DeviceFormat
type Output = DeviceFormat
!
operator.Source§impl Octal for DeviceFormat
impl Octal for DeviceFormat
Source§impl Ord for DeviceFormat
impl Ord for DeviceFormat
Source§fn cmp(&self, other: &DeviceFormat) -> Ordering
fn cmp(&self, other: &DeviceFormat) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialEq for DeviceFormat
impl PartialEq for DeviceFormat
Source§impl PartialOrd for DeviceFormat
impl PartialOrd for DeviceFormat
Source§impl Sub for DeviceFormat
impl Sub for DeviceFormat
Source§fn sub(self, other: DeviceFormat) -> DeviceFormat
fn sub(self, other: DeviceFormat) -> DeviceFormat
Returns the set difference of the two sets of flags.
Source§type Output = DeviceFormat
type Output = DeviceFormat
-
operator.Source§impl SubAssign for DeviceFormat
impl SubAssign for DeviceFormat
Source§fn sub_assign(&mut self, other: DeviceFormat)
fn sub_assign(&mut self, other: DeviceFormat)
Disables all flags enabled in the set.