Struct h2::frame::stream_id::StreamId

pub struct StreamId(u32);

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.

Tuple Fields

0: u32

Implementations

impl StreamId

pub const ZERO: StreamId = _

Stream ID 0.

pub const MAX: StreamId = _

The maximum allowed stream ID.

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

Parse the stream ID

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

fn from(src: StreamId) -> Self

Converts to this type from the input type.

impl From<u32> for StreamId

fn from(src: u32) -> 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<u32> for StreamId

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