Struct Stream 

pub struct Stream { /* private fields */ }

A manually managed stream identity.

A Stream is a pure identity: it owns no backend resources (backend streams are pool-managed by the runtimes) and is freely copyable. Use it to pin work to a stable stream regardless of which thread or task executes it:

• Stream::enter runs synchronous work on the stream.
• Stream::attach binds a future to the stream, surviving executor work-stealing on any async runtime.
• Stream::spawn runs a closure on a fresh OS thread bound to a fresh stream (native std only).

Implementations

impl Stream

pub fn new() -> Self

Creates a new stream with a freshly allocated identity.

pub const fn from_id(id: StreamId) -> Self

Adopts an existing stream id.

pub fn id(&self) -> StreamId

The underlying stream id.

pub fn enter<R>(&self, f: impl FnOnce() -> R) -> R

Runs f on this stream, restoring the previous stream afterward, including on unwind.

pub fn attach<F: Future>(&self, fut: F) -> StreamFuture<F>

Binds a future to this stream.

The returned future re-establishes the stream around every poll, so the binding survives executor work-stealing on any async runtime, without requiring any particular executor.

impl Stream

pub fn spawn<T, F>(f: F) -> StreamJoinHandle<T>

where F: FnOnce() -> T + Send + 'static, T: Send + 'static,

Runs f on a fresh OS thread bound to a fresh stream.

Everything submitted inside f targets the new stream, concurrent with work on other streams.

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Stream

impl Debug for Stream

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

Formats the value using the given formatter.

impl Eq for Stream

impl Hash for Stream

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Stream

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Stream