Struct gfx_hal::query::ResultFlags
source · [−]pub struct ResultFlags { /* private fields */ }
Expand description
Query result flags.
Implementations
sourceimpl ResultFlags
impl ResultFlags
sourcepub const WAIT: Self
pub const WAIT: Self
Wait for each query’s status to become available before retrieving its results.
sourcepub const WITH_AVAILABILITY: Self
pub const WITH_AVAILABILITY: Self
Availability status accompanies the results.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
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) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> 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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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
sourceimpl Binary for ResultFlags
impl Binary for ResultFlags
sourceimpl BitAnd<ResultFlags> for ResultFlags
impl BitAnd<ResultFlags> for ResultFlags
sourceimpl BitAndAssign<ResultFlags> for ResultFlags
impl BitAndAssign<ResultFlags> for ResultFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ResultFlags> for ResultFlags
impl BitOr<ResultFlags> for ResultFlags
sourcefn bitor(self, other: ResultFlags) -> Self
fn bitor(self, other: ResultFlags) -> Self
Returns the union of the two sets of flags.
type Output = Self
type Output = Self
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ResultFlags> for ResultFlags
impl BitOrAssign<ResultFlags> for ResultFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ResultFlags> for ResultFlags
impl BitXor<ResultFlags> for ResultFlags
sourceimpl BitXorAssign<ResultFlags> for ResultFlags
impl BitXorAssign<ResultFlags> for ResultFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ResultFlags
impl Clone for ResultFlags
sourcefn clone(&self) -> ResultFlags
fn clone(&self) -> ResultFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ResultFlags
impl Debug for ResultFlags
sourceimpl Extend<ResultFlags> for ResultFlags
impl Extend<ResultFlags> for ResultFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<ResultFlags> for ResultFlags
impl FromIterator<ResultFlags> for ResultFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for ResultFlags
impl Hash for ResultFlags
sourceimpl LowerHex for ResultFlags
impl LowerHex for ResultFlags
sourceimpl Not for ResultFlags
impl Not for ResultFlags
sourceimpl Octal for ResultFlags
impl Octal for ResultFlags
sourceimpl Ord for ResultFlags
impl Ord for ResultFlags
sourceimpl PartialEq<ResultFlags> for ResultFlags
impl PartialEq<ResultFlags> for ResultFlags
sourcefn eq(&self, other: &ResultFlags) -> bool
fn eq(&self, other: &ResultFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ResultFlags) -> bool
fn ne(&self, other: &ResultFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ResultFlags> for ResultFlags
impl PartialOrd<ResultFlags> for ResultFlags
sourcefn partial_cmp(&self, other: &ResultFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ResultFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<ResultFlags> for ResultFlags
impl Sub<ResultFlags> for ResultFlags
sourceimpl SubAssign<ResultFlags> for ResultFlags
impl SubAssign<ResultFlags> for ResultFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for ResultFlags
impl UpperHex for ResultFlags
impl Copy for ResultFlags
impl Eq for ResultFlags
impl StructuralEq for ResultFlags
impl StructuralPartialEq for ResultFlags
Auto Trait Implementations
impl RefUnwindSafe for ResultFlags
impl Send for ResultFlags
impl Sync for ResultFlags
impl Unpin for ResultFlags
impl UnwindSafe for ResultFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more