Struct ocl::flags::MemMigrationFlags
source · pub struct MemMigrationFlags { /* private fields */ }
Expand description
cl_mem_migration_flags - bitfield
Implementations§
source§impl MemMigrationFlags
impl MemMigrationFlags
pub const OBJECT_HOST: MemMigrationFlags = _
pub const OBJECT_CONTENT_UNDEFINED: MemMigrationFlags = _
sourcepub const fn empty() -> MemMigrationFlags
pub const fn empty() -> MemMigrationFlags
Returns an empty set of flags.
sourcepub const fn all() -> MemMigrationFlags
pub const fn all() -> MemMigrationFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u64) -> Option<MemMigrationFlags>
pub const fn from_bits(bits: u64) -> Option<MemMigrationFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u64) -> MemMigrationFlags
pub const fn from_bits_truncate(bits: u64) -> MemMigrationFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> MemMigrationFlags
pub const unsafe fn from_bits_unchecked(bits: u64) -> MemMigrationFlags
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: MemMigrationFlags) -> bool
pub const fn intersects(&self, other: MemMigrationFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: MemMigrationFlags) -> bool
pub const fn contains(&self, other: MemMigrationFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: MemMigrationFlags)
pub fn insert(&mut self, other: MemMigrationFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: MemMigrationFlags)
pub fn remove(&mut self, other: MemMigrationFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: MemMigrationFlags)
pub fn toggle(&mut self, other: MemMigrationFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: MemMigrationFlags, value: bool)
pub fn set(&mut self, other: MemMigrationFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: MemMigrationFlags) -> MemMigrationFlags
pub const fn intersection(self, other: MemMigrationFlags) -> MemMigrationFlags
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: MemMigrationFlags) -> MemMigrationFlags
pub const fn union(self, other: MemMigrationFlags) -> MemMigrationFlags
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: MemMigrationFlags) -> MemMigrationFlags
pub const fn difference(self, other: MemMigrationFlags) -> MemMigrationFlags
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: MemMigrationFlags
) -> MemMigrationFlags
pub const fn symmetric_difference( self, other: MemMigrationFlags ) -> MemMigrationFlags
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) -> MemMigrationFlags
pub const fn complement(self) -> MemMigrationFlags
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 MemMigrationFlags
impl Binary for MemMigrationFlags
source§impl BitAnd for MemMigrationFlags
impl BitAnd for MemMigrationFlags
source§fn bitand(self, other: MemMigrationFlags) -> MemMigrationFlags
fn bitand(self, other: MemMigrationFlags) -> MemMigrationFlags
Returns the intersection between the two sets of flags.
§type Output = MemMigrationFlags
type Output = MemMigrationFlags
&
operator.source§impl BitAndAssign for MemMigrationFlags
impl BitAndAssign for MemMigrationFlags
source§fn bitand_assign(&mut self, other: MemMigrationFlags)
fn bitand_assign(&mut self, other: MemMigrationFlags)
Disables all flags disabled in the set.
source§impl BitOr for MemMigrationFlags
impl BitOr for MemMigrationFlags
source§fn bitor(self, other: MemMigrationFlags) -> MemMigrationFlags
fn bitor(self, other: MemMigrationFlags) -> MemMigrationFlags
Returns the union of the two sets of flags.
§type Output = MemMigrationFlags
type Output = MemMigrationFlags
|
operator.source§impl BitOrAssign for MemMigrationFlags
impl BitOrAssign for MemMigrationFlags
source§fn bitor_assign(&mut self, other: MemMigrationFlags)
fn bitor_assign(&mut self, other: MemMigrationFlags)
Adds the set of flags.
source§impl BitXor for MemMigrationFlags
impl BitXor for MemMigrationFlags
source§fn bitxor(self, other: MemMigrationFlags) -> MemMigrationFlags
fn bitxor(self, other: MemMigrationFlags) -> MemMigrationFlags
Returns the left flags, but with all the right flags toggled.
§type Output = MemMigrationFlags
type Output = MemMigrationFlags
^
operator.source§impl BitXorAssign for MemMigrationFlags
impl BitXorAssign for MemMigrationFlags
source§fn bitxor_assign(&mut self, other: MemMigrationFlags)
fn bitxor_assign(&mut self, other: MemMigrationFlags)
Toggles the set of flags.
source§impl Clone for MemMigrationFlags
impl Clone for MemMigrationFlags
source§fn clone(&self) -> MemMigrationFlags
fn clone(&self) -> MemMigrationFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MemMigrationFlags
impl Debug for MemMigrationFlags
source§impl Extend<MemMigrationFlags> for MemMigrationFlags
impl Extend<MemMigrationFlags> for MemMigrationFlags
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = MemMigrationFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = MemMigrationFlags>,
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<MemMigrationFlags> for MemMigrationFlags
impl FromIterator<MemMigrationFlags> for MemMigrationFlags
source§fn from_iter<T>(iterator: T) -> MemMigrationFlagswhere
T: IntoIterator<Item = MemMigrationFlags>,
fn from_iter<T>(iterator: T) -> MemMigrationFlagswhere
T: IntoIterator<Item = MemMigrationFlags>,
source§impl Hash for MemMigrationFlags
impl Hash for MemMigrationFlags
source§impl LowerHex for MemMigrationFlags
impl LowerHex for MemMigrationFlags
source§impl Not for MemMigrationFlags
impl Not for MemMigrationFlags
source§fn not(self) -> MemMigrationFlags
fn not(self) -> MemMigrationFlags
Returns the complement of this set of flags.
§type Output = MemMigrationFlags
type Output = MemMigrationFlags
!
operator.source§impl Octal for MemMigrationFlags
impl Octal for MemMigrationFlags
source§impl Ord for MemMigrationFlags
impl Ord for MemMigrationFlags
source§fn cmp(&self, other: &MemMigrationFlags) -> Ordering
fn cmp(&self, other: &MemMigrationFlags) -> 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 MemMigrationFlags
impl PartialEq for MemMigrationFlags
source§fn eq(&self, other: &MemMigrationFlags) -> bool
fn eq(&self, other: &MemMigrationFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for MemMigrationFlags
impl PartialOrd for MemMigrationFlags
source§fn partial_cmp(&self, other: &MemMigrationFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &MemMigrationFlags) -> 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 MemMigrationFlags
impl Sub for MemMigrationFlags
source§fn sub(self, other: MemMigrationFlags) -> MemMigrationFlags
fn sub(self, other: MemMigrationFlags) -> MemMigrationFlags
Returns the set difference of the two sets of flags.
§type Output = MemMigrationFlags
type Output = MemMigrationFlags
-
operator.source§impl SubAssign for MemMigrationFlags
impl SubAssign for MemMigrationFlags
source§fn sub_assign(&mut self, other: MemMigrationFlags)
fn sub_assign(&mut self, other: MemMigrationFlags)
Disables all flags enabled in the set.