Struct Stream 

pub struct Stream { /* private fields */ }

One streaming session, on either side. Cloning it shares the session.

Implementations

impl Stream

pub fn report(&self) -> Result<Report, ReportError>

This caller stream’s seal report. It settles on the provider’s first STREAM_DATA or STREAM_REPLY opened under the stream’s key; on a clear stream, on its first STREAM_DATA, STREAM_REPLY or STREAM_END. A sealed stream’s STREAM_END travels clear and settles nothing, and no error settles a stream. Before it settles, and on a stream that ended first, it is ReportError::NotSettled; on a served stream, ReportError::NotACaller. A stream that settled and then ended, an error included, keeps its report.

impl Stream

pub fn request(&self) -> &VerifiedRequest

The stream’s verified STREAM_OPEN: its caller, procedure, mode and payload. On a provider’s side of a sealed stream the payload is the open’s opened plaintext.

pub fn sealed(&self) -> bool

Whether the stream is sealed end to end: every chunk, reply and error after the open travels sealed.

pub async fn send(&self, body: &[u8]) -> Result<(), LinkError>

Sends a raw chunk.

pub async fn send_value(&self, v: Value) -> Result<(), LinkError>

Sends a structured chunk.

pub async fn close_send(&self) -> Result<(), LinkError>

Ends this side’s sending; the peer may still send.

pub async fn close(&self) -> Result<(), LinkError>

Ends the stream on both sides.

pub async fn reply(&self, payload: Value) -> Result<(), LinkError>

Sends the provider’s terminal value and ends the stream.

pub async fn abort(&self, code: &str, message: &str) -> Result<(), LinkError>

Ends the stream with a STREAM_ERROR of code and message.

pub async fn recv(&self) -> Result<StreamEvent, LinkError>

The next frame the peer sent. After the stream ends, once every event before it is read, it returns LinkError::EndOfStream for a normal end and the error that ended it otherwise.

pub async fn done(&self) -> Option<LinkError>

Waits until the stream has ended and been released, and says why: None for a normal end.

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.