Struct StreamReader

pub struct StreamReader {
    pub(crate) target: StreamTarget,
    pub(crate) receiver: Receiver<UnparsedRelayMsg, MpscSpec>,
    pub(crate) recv_window: RecvWindow<StreamParams>,
    pub(crate) ended: bool,
}

The read part of a stream on a particular circuit.

Fields

target: StreamTarget

The underlying StreamTarget for this stream.

A reader has this target in order to:

• Make the reactor send SENDME messages.
• Tell the reactor when there is a protocol error.
• Keep the stream alive at least until the StreamReader is dropped.

receiver: Receiver<UnparsedRelayMsg, MpscSpec>

Channel to receive stream messages from the reactor.

recv_window: RecvWindow<StreamParams>

Congestion control receive window for this stream.

Having this here means we’re only going to update it when the end consumer of this stream actually reads things, meaning we don’t ask for more data until it’s actually needed (as opposed to having the reactor assume we’re always reading, and potentially overwhelm itself with having to buffer data).

ended: bool

Whether or not this stream has ended.

Implementations

impl StreamReader

async fn recv_raw(&mut self) -> Result<UnparsedRelayMsg>

Try to read the next relay message from this stream.

pub async fn recv(&mut self) -> Result<UnparsedRelayMsg>

As recv_raw, but if there is an error or an end cell, note that this stream has ended.

pub fn protocol_error(&mut self)

Shut down this stream.

Trait Implementations

impl Debug for StreamReader

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

Formats the value using the given formatter.