Enum StreamPolicy 

#[non_exhaustive]
pub enum StreamPolicy {
    PerThread,
    PerTask,
    Single,
}

How the current stream is derived when no explicit override is active.

Loaded from the [streaming] section of cubecl.toml by cubecl-runtime, or set programmatically with set_policy. An explicit set_policy call always wins over the configuration file.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PerThread

One stream per OS thread (the historical behavior and the default).

Correct for applications that submit work from plain threads. Under an async executor with work stealing, a logical task hopping between worker threads changes streams, causing spurious synchronization.

PerTask

One stream per logical task.

With the tokio feature enabled, a task keeps a stable stream across .await points even when the executor moves it between worker threads. Outside a task, or without the tokio feature, this behaves like PerThread.

Single

Everything runs on stream 0.

The effective behavior on wasm and no-std targets today.

Trait Implementations

impl Clone for StreamPolicy

fn clone(&self) -> StreamPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamPolicy

impl Debug for StreamPolicy

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

Formats the value using the given formatter.

impl Default for StreamPolicy

fn default() -> StreamPolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StreamPolicy

fn deserialize<__D>( __deserializer: __D, ) -> Result<StreamPolicy, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StreamPolicy

impl PartialEq for StreamPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StreamPolicy

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamPolicy