[][src]Struct rustacuda::stream::StreamFlags

pub struct StreamFlags { /* fields omitted */ }

Bit flags for configuring a CUDA Stream.

Implementations

impl StreamFlags[src]

pub const DEFAULT: StreamFlags[src]

No flags set.

pub const NON_BLOCKING: StreamFlags[src]

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[src]

Returns an empty set of flags

pub const fn all() -> StreamFlags[src]

Returns the set containing all flags.

pub const fn bits(&self) -> u32[src]

Returns the raw value of the flags currently stored.

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

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[src]

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

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

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

pub const fn is_empty(&self) -> bool[src]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[src]

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for StreamFlags[src]

impl BitAnd<StreamFlags> for StreamFlags[src]

type Output = StreamFlags

The resulting type after applying the & operator.

fn bitand(self, other: StreamFlags) -> StreamFlags[src]

Returns the intersection between the two sets of flags.

impl BitAndAssign<StreamFlags> for StreamFlags[src]

fn bitand_assign(&mut self, other: StreamFlags)[src]

Disables all flags disabled in the set.

impl BitOr<StreamFlags> for StreamFlags[src]

type Output = StreamFlags

The resulting type after applying the | operator.

fn bitor(self, other: StreamFlags) -> StreamFlags[src]

Returns the union of the two sets of flags.

impl BitOrAssign<StreamFlags> for StreamFlags[src]

fn bitor_assign(&mut self, other: StreamFlags)[src]

Adds the set of flags.

impl BitXor<StreamFlags> for StreamFlags[src]

type Output = StreamFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: StreamFlags) -> StreamFlags[src]

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

impl BitXorAssign<StreamFlags> for StreamFlags[src]

fn bitxor_assign(&mut self, other: StreamFlags)[src]

Toggles the set of flags.

impl Clone for StreamFlags[src]

impl Copy for StreamFlags[src]

impl Debug for StreamFlags[src]

impl Eq for StreamFlags[src]

impl Extend<StreamFlags> for StreamFlags[src]

impl FromIterator<StreamFlags> for StreamFlags[src]

impl Hash for StreamFlags[src]

impl LowerHex for StreamFlags[src]

impl Not for StreamFlags[src]

type Output = StreamFlags

The resulting type after applying the ! operator.

fn not(self) -> StreamFlags[src]

Returns the complement of this set of flags.

impl Octal for StreamFlags[src]

impl Ord for StreamFlags[src]

impl PartialEq<StreamFlags> for StreamFlags[src]

impl PartialOrd<StreamFlags> for StreamFlags[src]

impl StructuralEq for StreamFlags[src]

impl StructuralPartialEq for StreamFlags[src]

impl Sub<StreamFlags> for StreamFlags[src]

type Output = StreamFlags

The resulting type after applying the - operator.

fn sub(self, other: StreamFlags) -> StreamFlags[src]

Returns the set difference of the two sets of flags.

impl SubAssign<StreamFlags> for StreamFlags[src]

fn sub_assign(&mut self, other: StreamFlags)[src]

Disables all flags enabled in the set.

impl UpperHex for StreamFlags[src]

Auto Trait Implementations

impl RefUnwindSafe for StreamFlags

impl Send for StreamFlags

impl Sync for StreamFlags

impl Unpin for StreamFlags

impl UnwindSafe for StreamFlags

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.