Struct StreamId

pub struct StreamId(/* private fields */);

Identify a single stream on a circuit.

These identifiers are local to each hop on a circuit. This can’t be zero; if you need something that can be zero in the protocol, use Option<StreamId>.

Implementations

impl StreamId

pub fn new(stream_id: u16) -> Option<Self>

Creates a StreamId for non-zero stream_id.

Returns None when stream_id is zero. Messages with a zero/None stream ID apply to the circuit as a whole instead of a particular stream.

pub fn get_or_zero(stream_id: Option<Self>) -> u16

Convenience function to convert to a u16; None is mapped to 0.

Trait Implementations

impl Clone for StreamId

fn clone(&self) -> StreamId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamId

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

Formats the value using the given formatter.

impl Display for StreamId

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

Formats the value using the given formatter.

impl From<NonZero<u16>> for StreamId

fn from(id: NonZeroU16) -> Self

Converts to this type from the input type.

impl From<StreamId> for NonZeroU16

fn from(id: StreamId) -> NonZeroU16

Converts to this type from the input type.

impl From<StreamId> for u16

fn from(id: StreamId) -> u16

Converts to this type from the input type.

impl HasMemoryCostStructural for StreamId

fn indirect_memory_cost(&self, et: EnabledToken) -> usize

Memory cost of data stored out-of-line

impl Hash for StreamId

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

impl Eq for StreamId

impl StructuralPartialEq for StreamId