Struct s2n_quic_core::stream::StreamId

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

The ID of a stream.

A stream ID is a 62-bit integer (0 to 2^62-1) that is unique for all streams on a connection.

Implementations

impl StreamId

pub const fn from_varint(id: VarInt) -> StreamId

Creates a Stream ID from a VarInt.

This is always a safe conversion, since Stream IDs and VarInts share the same range.

pub const fn as_varint(self) -> VarInt

Converts the stream id into a VarInt

pub fn initial(initiator: Type, stream_type: StreamType) -> StreamId

Returns the initial Stream ID for a given stream type.

E.g. the initial Stream ID for a server initiated unidirectional Stream is Stream ID 3.

Example:

let stream_id = StreamId::initial(endpoint::Type::Server, StreamType::Unidirectional);
// Initial server initiated unidirectional Stream ID is 3
assert_eq!(3u64, stream_id.as_varint().as_u64());

pub fn nth(initiator: Type, stream_type: StreamType, n: u64) -> Option<StreamId>

Returns the n-th StreamId for a certain type of Stream.

The 0th StreamId thereby represents the StreamId which is returned by the Self::initial method. All further StreamIds of a certain type will be spaced apart by 4.

nth() will return None if the resulting StreamId would not be valid.

pub fn next_of_type(self) -> Option<StreamId>

Returns the next StreamId which is of the same type the one referred to. E.g. if the method is called on a Stream ID for an unidirectional client initiated stream, the Stream ID of the next unidirectional client initiated stream will be returned.

Returns None if the next Stream ID would not be valid, due to being out of bounds.

Example:

let stream_id = StreamId::initial(endpoint::Type::Client, StreamType::Unidirectional);
// Initial client initiated unidirectional Stream ID is 2
assert_eq!(2u64, stream_id.as_varint().as_u64());
// Get the next client initiated Stream ID
let next_stream_id = stream_id.next_of_type();
assert_eq!(6u64, next_stream_id.expect("Next Stream ID is valid").as_varint().as_u64());

pub fn initiator(self) -> Type

Returns whether the client or server initiated the Stream

pub fn stream_type(self) -> StreamType

Returns whether the Stream is unidirectional or bidirectional.

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

fn from(id: StreamId) -> Self

Converts to this type from the input type.

impl From<StreamId> for u64

fn from(id: StreamId) -> Self

Converts to this type from the input type.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for StreamId

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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