Struct StreamFlags

Source
pub struct StreamFlags { /* private fields */ }
Expand description

Bit flags for configuring a CUDA Stream.

Implementations§

Source§

impl StreamFlags

Source

pub const DEFAULT: StreamFlags

No flags set.

Source

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.

Source

pub const fn empty() -> StreamFlags

Returns an empty set of flags

Source

pub const fn all() -> StreamFlags

Returns the set containing all flags.

Source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

Source

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.

Source

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

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

Source

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).

Source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

Source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

Source

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

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

Source

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

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

Source

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

Inserts the specified flags in-place.

Source

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

Removes the specified flags in-place.

Source

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

Toggles the specified flags in-place.

Source

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

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

Trait Implementations§

Source§

impl Binary for StreamFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl BitAnd for StreamFlags

Source§

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

Returns the intersection between the two sets of flags.

Source§

type Output = StreamFlags

The resulting type after applying the & operator.
Source§

impl BitAndAssign for StreamFlags

Source§

fn bitand_assign(&mut self, other: StreamFlags)

Disables all flags disabled in the set.

Source§

impl BitOr for StreamFlags

Source§

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

Returns the union of the two sets of flags.

Source§

type Output = StreamFlags

The resulting type after applying the | operator.
Source§

impl BitOrAssign for StreamFlags

Source§

fn bitor_assign(&mut self, other: StreamFlags)

Adds the set of flags.

Source§

impl BitXor for StreamFlags

Source§

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

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

Source§

type Output = StreamFlags

The resulting type after applying the ^ operator.
Source§

impl BitXorAssign for StreamFlags

Source§

fn bitxor_assign(&mut self, other: StreamFlags)

Toggles the set of flags.

Source§

impl Clone for StreamFlags

Source§

fn clone(&self) -> StreamFlags

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Extend<StreamFlags> for StreamFlags

Source§

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

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl FromIterator<StreamFlags> for StreamFlags

Source§

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

Creates a value from an iterator. Read more
Source§

impl Hash for StreamFlags

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl LowerHex for StreamFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Not for StreamFlags

Source§

fn not(self) -> StreamFlags

Returns the complement of this set of flags.

Source§

type Output = StreamFlags

The resulting type after applying the ! operator.
Source§

impl Octal for StreamFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Ord for StreamFlags

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for StreamFlags

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for StreamFlags

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Sub for StreamFlags

Source§

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

Returns the set difference of the two sets of flags.

Source§

type Output = StreamFlags

The resulting type after applying the - operator.
Source§

impl SubAssign for StreamFlags

Source§

fn sub_assign(&mut self, other: StreamFlags)

Disables all flags enabled in the set.

Source§

impl UpperHex for StreamFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for StreamFlags

Source§

impl Eq for StreamFlags

Source§

impl StructuralPartialEq for StreamFlags

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.