Struct StreamId 

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

Available on crate feature http only.

A stream identifier, as described in Section 5.1.1 of RFC 7540.

Streams are identified with an unsigned 31-bit integer. Streams initiated by a client MUST use odd-numbered stream identifiers; those initiated by the server MUST use even-numbered stream identifiers. A stream identifier of zero (0x0) is used for connection control messages; the stream identifier of zero cannot be used to establish a new stream.

Implementations

impl StreamId

pub const ZERO: StreamId

Stream ID 0.

pub const MAX: StreamId

The maximum allowed stream ID.

pub const fn new(raw: u32) -> StreamId

Construct a StreamId from a u32, silently masking off the reserved high bit (matching wire-decode semantics — RFC 9113 §5.1.1 mandates the high bit is reserved and MUST be ignored on receipt).

Use StreamId::checked when you want explicit validation that the reserved bit is unset.

pub const fn checked(raw: u32) -> Result<StreamId, Error>

Construct a StreamId from a u32, validating that the reserved high bit (RFC 9113 §5.1.1) is unset. Returns Error::ReservedStreamIdBit otherwise.

pub fn parse(buf: &[u8]) -> Result<(StreamId, bool), Error>

Parse a stream id from the first 4 bytes of buf.

Returns the parsed id plus a flag indicating whether the reserved high bit was set on the wire (caller-defined semantics; for PRIORITY this means the exclusive bit).

Errors with Error::ShortBuffer if buf.len() < 4.

pub fn is_client_initiated(&self) -> bool

Returns true if this stream ID corresponds to a stream that was initiated by the client.

pub fn is_server_initiated(&self) -> bool

Returns true if this stream ID corresponds to a stream that was initiated by the server.

pub fn zero() -> StreamId

Return a new StreamId for stream 0.

pub fn is_zero(&self) -> bool

Returns true if this stream ID is zero.

pub fn next_id(&self) -> Result<StreamId, StreamIdOverflow>

Returns the next stream ID initiated by the same peer as this stream ID, or an error if incrementing this stream ID would overflow the maximum.

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

fn from(src: StreamId) -> u32

Converts to this type from the input type.

impl From<u32> for StreamId

fn from(src: u32) -> StreamId

Infallible conversion that silently masks off the reserved high bit, matching wire-decode semantics (RFC 9113 §5.1.1 mandates ignoring it on receipt). Use StreamId::checked when you want explicit validation that the bit was unset.

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

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

impl Eq for StreamId

impl StructuralPartialEq for StreamId