Struct FrameStream

pub struct FrameStream<S, B> {
    pub stream: BufRecvStream<S, B>,
    /* private fields */
}

Available on crate feature h3 only.

Decodes Frames from the underlying QUIC stream

Fields

stream: BufRecvStream<S, B>

Implementations

impl<S, B> FrameStream<S, B>

pub fn new(stream: BufRecvStream<S, B>) -> FrameStream<S, B>

pub fn into_inner(self) -> BufRecvStream<S, B>

Unwraps the Framed streamer and returns the underlying stream without data loss for partially received/read frames.

impl<S, B> FrameStream<S, B>

where S: RecvStream,

pub fn poll_next( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Option<Frame<PayloadLen>>, FrameStreamError>>

Polls the stream for the next frame header

When a frame header is received use poll_data to retrieve the frame’s data.

pub fn poll_data( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Option<impl Buf>, FrameStreamError>>

Retrieves the next piece of data in an incoming data packet or webtransport stream

WebTransport bidirectional payload has no finite length and is processed until the end of the stream.

pub fn id(&self) -> StreamId

Trait Implementations

impl<T, B> SendStream<B> for FrameStream<T, B>

where T: SendStream<B>, B: Buf,

fn poll_ready( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), StreamErrorIncoming>>

Polls if the stream can send more data.

fn send_data<D>(&mut self, data: D) -> Result<(), StreamErrorIncoming>

where D: Into<WriteBuf<B>>,

Send more data on the stream.

fn poll_finish( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), StreamErrorIncoming>>

Poll to finish the sending side of the stream.

fn reset(&mut self, reset_code: u64)

Send a QUIC reset code.

fn send_id(&self) -> StreamId

Get QUIC send stream id