Struct StreamId

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

Identifies a (multiplexed) stream.

Stream IDs are variable-length integers with the least significant 3 bits denoting the stream type and initiator.

The first bit denotes the initiator (outbound or inbound), while the second and third bit denote the stream type. See StreamKind.

In a situation where Alice connects to Bob, Alice will have the initiator bit set to 1 for all streams she creates, while Bob will have it set to 0.

This ensures that Stream IDs never collide. Additionally, Stream IDs must never be re-used within a connection.

+=======+==================================+ | Bits | Stream Type | +=======+==================================+ | 0b000 | Outbound Control stream | +—––+–––––––––––––––––+ | 0b001 | Inbound Control stream | +—––+–––––––––––––––––+ | 0b010 | Outbound Gossip stream | +—––+–––––––––––––––––+ | 0b011 | Inbound Gossip stream | +—––+–––––––––––––––––+ | 0b100 | Outbound Git stream | +—––+–––––––––––––––––+ | 0b101 | Inbound Git stream | +—––+–––––––––––––––––+

Implementations

impl StreamId

pub fn link(&self) -> Link

Get the initiator of this stream.

pub fn kind(&self) -> Result<StreamKind, u8>

Get the kind of stream this is.

pub fn control(link: Link) -> StreamId

Create a control identifier.

pub fn gossip(link: Link) -> StreamId

Create a gossip identifier.

pub fn git(link: Link) -> StreamId

Create a git identifier.

pub fn nth(self, n: u64) -> Result<StreamId, BoundsExceeded>

Get the nth identifier while preserving the stream type and initiator.

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

fn decode(buf: &mut impl Buf) -> Result<StreamId, Error>

impl Display for StreamId

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

Formats the value using the given formatter.

impl Encode for StreamId

fn encode(&self, buf: &mut impl BufMut)

impl From<StreamId> for VarInt

fn from(value: StreamId) -> VarInt

Converts to this type from the input type.

impl From<StreamId> for u64

fn from(value: StreamId) -> u64

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

impl Eq for StreamId

impl StructuralPartialEq for StreamId