Struct rustacuda::stream::StreamFlags

pub struct StreamFlags { /* fields omitted */ }

Bit flags for configuring a CUDA Stream.

Methods

impl StreamFlags

pub const DEFAULT: StreamFlags

No flags set.

pub const NON_BLOCKING: StreamFlags

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.

pub const fn empty() -> StreamFlags

Returns an empty set of flags

pub const fn all() -> StreamFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<StreamFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> StreamFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> StreamFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: StreamFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: StreamFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: StreamFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: StreamFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: StreamFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: StreamFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for StreamFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl BitAnd<StreamFlags> for StreamFlags

type Output = StreamFlags

The resulting type after applying the & operator.

fn bitand(self, other: StreamFlags) -> StreamFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<StreamFlags> for StreamFlags

fn bitand_assign(&mut self, other: StreamFlags)

Disables all flags disabled in the set.

impl BitOr<StreamFlags> for StreamFlags

type Output = StreamFlags

The resulting type after applying the | operator.

fn bitor(self, other: StreamFlags) -> StreamFlags

Returns the union of the two sets of flags.

impl BitOrAssign<StreamFlags> for StreamFlags

fn bitor_assign(&mut self, other: StreamFlags)

Adds the set of flags.

impl BitXor<StreamFlags> for StreamFlags

type Output = StreamFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: StreamFlags) -> StreamFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<StreamFlags> for StreamFlags

fn bitxor_assign(&mut self, other: StreamFlags)

Toggles the set of flags.

impl Clone for StreamFlags

fn clone(&self) -> StreamFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for StreamFlags

impl Debug for StreamFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for StreamFlags

impl Extend<StreamFlags> for StreamFlags

fn extend<T: IntoIterator<Item = StreamFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<StreamFlags> for StreamFlags

fn from_iter<T: IntoIterator<Item = StreamFlags>>(iterator: T) -> StreamFlags

Creates a value from an iterator.

impl Hash for StreamFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for StreamFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Not for StreamFlags

type Output = StreamFlags

The resulting type after applying the ! operator.

fn not(self) -> StreamFlags

Returns the complement of this set of flags.

impl Octal for StreamFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Ord for StreamFlags

fn cmp(&self, other: &StreamFlags) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<StreamFlags> for StreamFlags

fn eq(&self, other: &StreamFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StreamFlags) -> bool

This method tests for !=.

impl PartialOrd<StreamFlags> for StreamFlags

fn partial_cmp(&self, other: &StreamFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &StreamFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &StreamFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &StreamFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &StreamFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for StreamFlags

impl StructuralPartialEq for StreamFlags

impl Sub<StreamFlags> for StreamFlags

type Output = StreamFlags

The resulting type after applying the - operator.

fn sub(self, other: StreamFlags) -> StreamFlags

Returns the set difference of the two sets of flags.

impl SubAssign<StreamFlags> for StreamFlags

fn sub_assign(&mut self, other: StreamFlags)

Disables all flags enabled in the set.

impl UpperHex for StreamFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.