Struct rustacuda::stream::StreamFlags
source · pub struct StreamFlags { /* private fields */ }
Expand description
Bit flags for configuring a CUDA Stream.
Implementations§
source§impl StreamFlags
impl StreamFlags
sourcepub const NON_BLOCKING: Self = _
pub const NON_BLOCKING: Self = _
This stream does not synchronize with the NULL stream.
Note that the name is chosen to correspond to CUDA documentation, but is nevertheless misleading. All work within a single stream is ordered and asynchronous regardless of whether this flag is set. All streams in RustaCUDA may execute work concurrently, regardless of the flag. However, for legacy reasons, CUDA has a notion of a NULL stream, which is used as the default when no other stream is provided. Work on other streams may not be executed concurrently with work on the NULL stream unless this flag is set. Since RustaCUDA does not provide access to the NULL stream, this flag has no effect in most circumstances. However, it is recommended to use it anyway, as some other crate in this binary may be using the NULL stream directly.
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§
source§impl Binary for StreamFlags
impl Binary for StreamFlags
source§impl BitAnd<StreamFlags> for StreamFlags
impl BitAnd<StreamFlags> for StreamFlags
source§impl BitAndAssign<StreamFlags> for StreamFlags
impl BitAndAssign<StreamFlags> for StreamFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<StreamFlags> for StreamFlags
impl BitOr<StreamFlags> for StreamFlags
source§fn bitor(self, other: StreamFlags) -> Self
fn bitor(self, other: StreamFlags) -> Self
Returns the union of the two sets of flags.
§type Output = StreamFlags
type Output = StreamFlags
|
operator.source§impl BitOrAssign<StreamFlags> for StreamFlags
impl BitOrAssign<StreamFlags> for StreamFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<StreamFlags> for StreamFlags
impl BitXor<StreamFlags> for StreamFlags
source§impl BitXorAssign<StreamFlags> for StreamFlags
impl BitXorAssign<StreamFlags> for StreamFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for StreamFlags
impl Clone for StreamFlags
source§fn clone(&self) -> StreamFlags
fn clone(&self) -> StreamFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StreamFlags
impl Debug for StreamFlags
source§impl Extend<StreamFlags> for StreamFlags
impl Extend<StreamFlags> for StreamFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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<StreamFlags> for StreamFlags
impl FromIterator<StreamFlags> for StreamFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for StreamFlags
impl Hash for StreamFlags
source§impl LowerHex for StreamFlags
impl LowerHex for StreamFlags
source§impl Not for StreamFlags
impl Not for StreamFlags
source§impl Octal for StreamFlags
impl Octal for StreamFlags
source§impl Ord for StreamFlags
impl Ord for StreamFlags
source§fn cmp(&self, other: &StreamFlags) -> Ordering
fn cmp(&self, other: &StreamFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<StreamFlags> for StreamFlags
impl PartialEq<StreamFlags> for StreamFlags
source§fn eq(&self, other: &StreamFlags) -> bool
fn eq(&self, other: &StreamFlags) -> bool
source§impl PartialOrd<StreamFlags> for StreamFlags
impl PartialOrd<StreamFlags> for StreamFlags
source§fn partial_cmp(&self, other: &StreamFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StreamFlags) -> 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<StreamFlags> for StreamFlags
impl Sub<StreamFlags> for StreamFlags
source§impl SubAssign<StreamFlags> for StreamFlags
impl SubAssign<StreamFlags> for StreamFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.