Struct StreamId

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

Streams are identified within a connection by a numeric value, referred to as the stream ID.

A stream ID is a 62-bit integer (0 to 262-1) that is unique for all streams on a connection. Stream IDs are encoded as VarInt. A QUIC endpoint MUST NOT reuse a stream ID within a connection.

There are four types of streams in QUIC, divided according to the role and direction of the stream. See Stream ID Types of QUIC for more details.

Implementations

impl StreamId

pub fn new(role: Role, dir: Dir, id: u64) -> StreamId

Create a new stream ID with the given role, direction, and ID.

It is prohibited to directly create a StreamId from external sources. StreamId can only be allocated incrementally by proactively creating new streams locally. or accepting new streams opened by peer.

pub fn role(&self) -> Role

Returns the role of this stream ID.

pub fn dir(&self) -> Dir

Returns the direction of this stream ID.

pub fn id(&self) -> u64

Get the actual ID of this stream, removing the lowest 2 bits for direction and role.

pub fn encoding_size(&self) -> usize

Return the encoding size of this stream ID.

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<(), Error>

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

fn from(s: StreamId) -> VarInt

Converts to this type from the input type.

impl From<VarInt> for StreamId

fn from(v: VarInt) -> StreamId

Converts to this type from the input type.

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

impl Eq for StreamId

impl StructuralPartialEq for StreamId