Struct gpu_alloc::AllocationFlags
source · pub struct AllocationFlags(/* private fields */);
Expand description
Allocation flags
Implementations§
source§impl AllocationFlags
impl AllocationFlags
sourcepub const DEVICE_ADDRESS: AllocationFlags = _
pub const DEVICE_ADDRESS: AllocationFlags = _
Specifies that the memory can be used for buffers created with flag that allows fetching device address.
source§impl AllocationFlags
impl AllocationFlags
sourcepub const fn empty() -> AllocationFlags
pub const fn empty() -> AllocationFlags
Get a flags value with all bits unset.
sourcepub const fn all() -> AllocationFlags
pub const fn all() -> AllocationFlags
Get a flags value with all known bits set.
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<AllocationFlags>
pub const fn from_bits(bits: u8) -> Option<AllocationFlags>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u8) -> AllocationFlags
pub const fn from_bits_truncate(bits: u8) -> AllocationFlags
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> AllocationFlags
pub const fn from_bits_retain(bits: u8) -> AllocationFlags
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<AllocationFlags>
pub fn from_name(name: &str) -> Option<AllocationFlags>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: AllocationFlags) -> bool
pub const fn intersects(&self, other: AllocationFlags) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: AllocationFlags) -> bool
pub const fn contains(&self, other: AllocationFlags) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn insert(&mut self, other: AllocationFlags)
pub fn insert(&mut self, other: AllocationFlags)
The bitwise or (|
) of the bits in two flags values.
sourcepub fn remove(&mut self, other: AllocationFlags)
pub fn remove(&mut self, other: AllocationFlags)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: AllocationFlags)
pub fn toggle(&mut self, other: AllocationFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: AllocationFlags, value: bool)
pub fn set(&mut self, other: AllocationFlags, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: AllocationFlags) -> AllocationFlags
pub const fn intersection(self, other: AllocationFlags) -> AllocationFlags
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: AllocationFlags) -> AllocationFlags
pub const fn union(self, other: AllocationFlags) -> AllocationFlags
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: AllocationFlags) -> AllocationFlags
pub const fn difference(self, other: AllocationFlags) -> AllocationFlags
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(
self,
other: AllocationFlags
) -> AllocationFlags
pub const fn symmetric_difference( self, other: AllocationFlags ) -> AllocationFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> AllocationFlags
pub const fn complement(self) -> AllocationFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl AllocationFlags
impl AllocationFlags
sourcepub const fn iter(&self) -> Iter<AllocationFlags>
pub const fn iter(&self) -> Iter<AllocationFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<AllocationFlags>
pub const fn iter_names(&self) -> IterNames<AllocationFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl Binary for AllocationFlags
impl Binary for AllocationFlags
source§impl BitAnd for AllocationFlags
impl BitAnd for AllocationFlags
source§fn bitand(self, other: AllocationFlags) -> AllocationFlags
fn bitand(self, other: AllocationFlags) -> AllocationFlags
The bitwise and (&
) of the bits in two flags values.
§type Output = AllocationFlags
type Output = AllocationFlags
&
operator.source§impl BitAndAssign for AllocationFlags
impl BitAndAssign for AllocationFlags
source§fn bitand_assign(&mut self, other: AllocationFlags)
fn bitand_assign(&mut self, other: AllocationFlags)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for AllocationFlags
impl BitOr for AllocationFlags
source§fn bitor(self, other: AllocationFlags) -> AllocationFlags
fn bitor(self, other: AllocationFlags) -> AllocationFlags
The bitwise or (|
) of the bits in two flags values.
§type Output = AllocationFlags
type Output = AllocationFlags
|
operator.source§impl BitOrAssign for AllocationFlags
impl BitOrAssign for AllocationFlags
source§fn bitor_assign(&mut self, other: AllocationFlags)
fn bitor_assign(&mut self, other: AllocationFlags)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for AllocationFlags
impl BitXor for AllocationFlags
source§fn bitxor(self, other: AllocationFlags) -> AllocationFlags
fn bitxor(self, other: AllocationFlags) -> AllocationFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
§type Output = AllocationFlags
type Output = AllocationFlags
^
operator.source§impl BitXorAssign for AllocationFlags
impl BitXorAssign for AllocationFlags
source§fn bitxor_assign(&mut self, other: AllocationFlags)
fn bitxor_assign(&mut self, other: AllocationFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for AllocationFlags
impl Clone for AllocationFlags
source§fn clone(&self) -> AllocationFlags
fn clone(&self) -> AllocationFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AllocationFlags
impl Debug for AllocationFlags
source§impl Extend<AllocationFlags> for AllocationFlags
impl Extend<AllocationFlags> for AllocationFlags
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = AllocationFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = AllocationFlags>,
The bitwise or (|
) of the bits in each flags value.
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 Flags for AllocationFlags
impl Flags for AllocationFlags
source§const FLAGS: &'static [Flag<AllocationFlags>] = _
const FLAGS: &'static [Flag<AllocationFlags>] = _
source§fn from_bits_retain(bits: u8) -> AllocationFlags
fn from_bits_retain(bits: u8) -> AllocationFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<AllocationFlags> for AllocationFlags
impl FromIterator<AllocationFlags> for AllocationFlags
source§fn from_iter<T>(iterator: T) -> AllocationFlagswhere
T: IntoIterator<Item = AllocationFlags>,
fn from_iter<T>(iterator: T) -> AllocationFlagswhere
T: IntoIterator<Item = AllocationFlags>,
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for AllocationFlags
impl Hash for AllocationFlags
source§impl IntoIterator for AllocationFlags
impl IntoIterator for AllocationFlags
§type Item = AllocationFlags
type Item = AllocationFlags
§type IntoIter = Iter<AllocationFlags>
type IntoIter = Iter<AllocationFlags>
source§fn into_iter(self) -> <AllocationFlags as IntoIterator>::IntoIter
fn into_iter(self) -> <AllocationFlags as IntoIterator>::IntoIter
source§impl LowerHex for AllocationFlags
impl LowerHex for AllocationFlags
source§impl Not for AllocationFlags
impl Not for AllocationFlags
source§fn not(self) -> AllocationFlags
fn not(self) -> AllocationFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§type Output = AllocationFlags
type Output = AllocationFlags
!
operator.source§impl Octal for AllocationFlags
impl Octal for AllocationFlags
source§impl Ord for AllocationFlags
impl Ord for AllocationFlags
source§fn cmp(&self, other: &AllocationFlags) -> Ordering
fn cmp(&self, other: &AllocationFlags) -> 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 AllocationFlags
impl PartialEq for AllocationFlags
source§fn eq(&self, other: &AllocationFlags) -> bool
fn eq(&self, other: &AllocationFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for AllocationFlags
impl PartialOrd for AllocationFlags
source§fn partial_cmp(&self, other: &AllocationFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &AllocationFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for AllocationFlags
impl Sub for AllocationFlags
source§fn sub(self, other: AllocationFlags) -> AllocationFlags
fn sub(self, other: AllocationFlags) -> AllocationFlags
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = AllocationFlags
type Output = AllocationFlags
-
operator.source§impl SubAssign for AllocationFlags
impl SubAssign for AllocationFlags
source§fn sub_assign(&mut self, other: AllocationFlags)
fn sub_assign(&mut self, other: AllocationFlags)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.