Struct async_cuda_npp::stream::Stream

pub struct Stream { /* private fields */ }

Represents an NPP stream.

An NPP stream is a thin wrapper around a normal CUDA stream (async_cuda_core::Stream). It manages some additional context information required in NPP to statelessly execute on a user-provided stream.

This struct implements Deref such that it can be used as a normal async_cuda_core::Stream as well.

Usage

If the caller wants to use a stream context for mixed NPP and non-NPP operations, they should create an NPP stream and pass it as CUDA stream when desired. This should work out-of-the-box since Stream dereferences to async_cuda_core::Stream.

Implementations

impl Stream

pub fn null() -> Self

Create an NPP Stream that represent the default stream, also known as the null stream.

This type is a wrapper around the actual CUDA stream type: async_cuda_core::Stream.

pub async fn new() -> Result<Self, Error>

Create a new Stream for use with NPP.

This type is a wrapper around the actual CUDA stream type: async_cuda_core::Stream.

Methods from Deref<Target = Stream>

pub async fn synchronize(&self) -> impl Future<Output = Result<(), Error>>

Synchronize stream. This future will only return once all currently enqueued work on the stream is done.

CUDA documentation

Behavior

In constrast to most of the API, this future does not become ready eagerly. Instead, a callback is pushed onto the given stream that will be invoked to make the future ready once all work on the stream that was previously queued asynchroneously is completed.

Internally, the future uses cudaStreamAddCallback to schedule the callback on the stream.

pub fn inner(&self) -> &Stream

Access the inner synchronous implementation of Stream.

Trait Implementations

impl Deref for Stream

type Target = Stream

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.