Struct StreamId 

pub struct StreamId {
    pub value: u64,
}

Unique identifier representing the stream on which work is submitted.

How the current stream is resolved depends on the active StreamPolicy and on any explicit override installed with StreamId::executes or Stream::enter.

Fields

value: u64

The value representing the stream id.

Implementations

impl StreamId

pub fn executes<F, T>(self, f: F) -> T

where F: FnOnce() -> T,

Executes f on this stream, restoring the previous stream afterward.

The previous state is saved before the call and restored on return — including on unwind — so the caller never has to manage raw override pairs. Restoring also works when no stream was active before the call.

pub fn current() -> StreamId

Get the current stream id.

Resolution order:

1. An explicit override installed by StreamId::executes.
2. The active StreamPolicy: a stable per-task id under PerTask, stream 0 under Single, or a lazily assigned per-thread id otherwise.

pub fn allocate() -> StreamId

Allocate a fresh stream id, distinct from every per-thread default.

On no-std targets there is a single stream, so this returns id 0.

Trait Implementations

impl Clone for StreamId

fn clone(&self) -> StreamId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamId

impl Debug for StreamId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StreamId

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

Formats the value using the given formatter.

impl Eq for StreamId

impl Hash for StreamId

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

where __H: Hasher,

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 Ord for StreamId

fn cmp(&self, other: &StreamId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StreamId

fn eq(&self, other: &StreamId) -> 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.

impl PartialOrd for StreamId

fn partial_cmp(&self, other: &StreamId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for StreamId

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 StreamId