Struct Stream

pub struct Stream { /* private fields */ }

A stream of evaluation attached to a particular device.

Typically, this is used via the stream: parameter on a method with a StreamOrDevice:

Implementations

impl Stream

pub fn task_local_or_default() -> Self

Create a new stream on the default device, or return the task local default stream if present.

pub fn task_local_or_cpu() -> Self

Create a new stream on the default cpu device, or return the task local default stream if present.

pub fn task_local_or_gpu() -> Self

Create a new stream on the default gpu device, or return the task local default stream if present.

pub fn new() -> Stream

Create a new stream on the default device. Panics if fails.

pub fn try_default_on_device(device: &Device) -> Result<Stream>

Try to get the default stream on the given device.

pub fn new_with_device(device: &Device) -> Stream

Create a new stream on the given device

pub fn as_ptr(&self) -> mlx_stream

Get the underlying C pointer.

pub fn cpu() -> Self

Current default CPU stream.

pub fn gpu() -> Self

Current default GPU stream.

pub fn get_index(&self) -> Result<i32>

Get the index of the stream.

Trait Implementations

impl AsRef<Stream> for Stream

fn as_ref(&self) -> &Stream

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Stream> for StreamOrDevice

fn as_ref(&self) -> &Stream

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Stream

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl Default for Stream

fn default() -> Self

Returns the “default value” for a type.

impl Display for Stream

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

Formats the value using the given formatter.

impl Drop for Stream

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Stream

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

Tests for self and other values to be equal, and is used by ==.

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

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