Struct Stream 

pub struct Stream<K, S> { /* private fields */ }

A QUIC/HTTP3/WebTransport stream.

Implementations

impl Stream<BiRemote, Quic>

pub fn accept_bi() -> Self

Creates a new remote-initialized bidirectional stream.

pub fn upgrade(self) -> StreamBiRemoteH3

Upgrades to an HTTP3 stream.

impl Stream<BiRemote, H3>

pub fn read_frame<'a, R>( &mut self, bytes_reader: &mut R, ) -> Result<Option<Frame<'a>>, ErrorCode>

where R: BytesReader<'a>,

See Frame::read.

pub async fn read_frame_async<'a, R>( &mut self, reader: &mut R, ) -> Result<Frame<'a>, IoReadError>

where R: AsyncRead + Unpin + ?Sized,

See Frame::read_async.

pub fn read_frame_from_buffer<'a>( &mut self, buffer_reader: &mut BufferReader<'a>, ) -> Result<Option<Frame<'a>>, ErrorCode>

See Frame::read_from_buffer.

pub fn write_frame<W>( &self, frame: Frame<'_>, bytes_writer: &mut W, ) -> Result<(), EndOfBuffer>

where W: BytesWriter,

See Frame::write.

pub async fn write_frame_async<W>( &self, frame: Frame<'_>, writer: &mut W, ) -> Result<(), IoWriteError>

where W: AsyncWrite + Unpin + ?Sized,

See Frame::write_async.

pub fn write_frame_to_buffer( &self, frame: Frame<'_>, buffer_writer: &mut BufferWriter<'_>, ) -> Result<(), EndOfBuffer>

See Frame::write_to_buffer.

pub fn upgrade(self, session_id: SessionId) -> StreamBiRemoteWT

Upgrades to a WebTransport stream.

Note: upgrade should be performed only when FrameKind::WebTransport is received as first frame on this HTTP3 stream.

pub fn into_session(self, session_request: SessionRequest) -> StreamSession

Converts the stream into a StreamSession.

impl Stream<BiRemote, WT>

pub fn session_id(&self) -> SessionId

Returns the SessionId associated with this stream.

impl Stream<BiLocal, Quic>

pub fn open_bi() -> Self

Creates a new locally-initialized bidirectional stream.

pub fn upgrade(self) -> StreamBiLocalH3

Upgrades to an HTTP3 stream.

impl Stream<BiLocal, H3>

pub fn read_frame<'a, R>( &self, bytes_reader: &mut R, ) -> Result<Option<Frame<'a>>, ErrorCode>

where R: BytesReader<'a>,

See Frame::read.

pub async fn read_frame_async<'a, R>( &self, reader: &mut R, ) -> Result<Frame<'a>, IoReadError>

where R: AsyncRead + Unpin + ?Sized,

See Frame::read_async.

pub fn read_frame_from_buffer<'a>( &self, buffer_reader: &mut BufferReader<'a>, ) -> Result<Option<Frame<'a>>, ErrorCode>

See Frame::read_from_buffer.

pub fn write_frame<W>( &mut self, frame: Frame<'_>, bytes_writer: &mut W, ) -> Result<(), EndOfBuffer>

where W: BytesWriter,

See Frame::write.

Panics

Panics if FrameKind::WebTransport (use upgrade for that).

pub async fn write_frame_async<W>( &mut self, frame: Frame<'_>, writer: &mut W, ) -> Result<(), IoWriteError>

where W: AsyncWrite + Unpin + ?Sized,

See Frame::write_async.

Panics

Panics if FrameKind::WebTransport (use upgrade for that).

pub fn write_frame_to_buffer( &mut self, frame: Frame<'_>, buffer_writer: &mut BufferWriter<'_>, ) -> Result<(), EndOfBuffer>

See Frame::write_to_buffer.

Panics

Panics if FrameKind::WebTransport (use upgrade for that).

pub fn upgrade<W>( self, session_id: SessionId, bytes_writer: &mut W, ) -> StreamBiLocalWT

where W: BytesWriter,

Upgrades to a WebTransport stream.

Panics

• Panics if any other I/O operation has been performed on this stream before upgrade.
• Panics if bytes_writer does not have enough capacity. See Self::upgrade_size.

pub async fn upgrade_async<W>( self, session_id: SessionId, writer: &mut W, ) -> Result<StreamBiLocalWT, IoWriteError>

where W: AsyncWrite + Unpin + ?Sized,

Upgrades to a WebTransport stream.

Panics

• Panics if any other I/O operation has been performed on this stream before upgrade.

pub fn upgrade_size(&self, session_id: SessionId) -> usize

Returns the needed capacity for upgrade via Self::upgrade.

pub fn into_session(self, session_request: SessionRequest) -> StreamSession

Converts the stream into a StreamSession.

impl Stream<BiLocal, WT>

pub fn session_id(&self) -> SessionId

Returns the SessionId associated with this stream.

impl Stream<UniRemote, Quic>

pub fn accept_uni() -> Self

Creates a new remote-initialized unidirectional stream.

pub fn upgrade<'a, R>( self, bytes_reader: &mut R, ) -> Result<MaybeUpgradeH3, ErrorCode>

where R: BytesReader<'a>,

Upgrades to an HTTP3 stream.

Because bytes_reader could not contain all required data, this behaves more like an attempt of upgrading.

In case there are no enough information, MaybeUpgradeH3::Quic (i.e, self) will be returned.

If the stream type is unknown ErrorCode::StreamCreation is returned. In that case, MUST NOT consider unknown stream types to be a connection error of any kind.

pub async fn upgrade_async<R>( self, reader: &mut R, ) -> Result<StreamUniRemoteH3, IoReadError>

where R: AsyncRead + Unpin + ?Sized,

Upgrades to an HTTP3 stream.

impl Stream<UniRemote, H3>

pub fn read_frame<'a, R>( &mut self, bytes_reader: &mut R, ) -> Result<Option<Frame<'a>>, ErrorCode>

where R: BytesReader<'a>,

See Frame::read.

Panics

Panics if the stream kind is StreamKind::WebTransport. In that case, use upgrade method.

pub async fn read_frame_async<'a, R>( &mut self, reader: &mut R, ) -> Result<Frame<'a>, IoReadError>

where R: AsyncRead + Unpin + ?Sized,

See Frame::read_async.

Panics

Panics if the stream kind is StreamKind::WebTransport. In that case, use upgrade method.

pub fn read_frame_from_buffer<'a>( &mut self, buffer_reader: &mut BufferReader<'a>, ) -> Result<Option<Frame<'a>>, ErrorCode>

See Frame::read_from_buffer.

Panics

Panics if the stream kind is StreamKind::WebTransport. In that case, use upgrade method.

pub fn upgrade(self) -> StreamUniRemoteWT

Upgrades to a WebTransport stream.

Panics

Panics if the stream kind is not StreamKind::WebTransport.

pub fn kind(&self) -> StreamKind

Returns the StreamKind associated with the stream.

pub fn session_id(&self) -> Option<SessionId>

Returns the SessionId if stream is StreamKind::WebTransport, otherwise returns None.

impl Stream<UniRemote, WT>

pub fn session_id(&self) -> SessionId

Returns the SessionId associated with this stream.

impl Stream<UniLocal, Quic>

pub fn open_uni() -> Self

Creates a new locally-initialized unidirectional stream.

pub fn upgrade<W>( self, stream_header: StreamHeader, bytes_writer: &mut W, ) -> StreamUniLocalH3

where W: BytesWriter,

Upgrades to an HTTP3 stream.

Panics

Panics if bytes_writer does not have enough capacity to write the stream_header. Check it with Self::upgrade_size.

pub async fn upgrade_async<W>( self, stream_header: StreamHeader, writer: &mut W, ) -> Result<StreamUniLocalH3, IoWriteError>

where W: AsyncWrite + Unpin + ?Sized,

Upgrades to an HTTP3 stream.

pub fn upgrade_size(stream_header: StreamHeader) -> usize

Returns the buffer capacity needed for Self::upgrade.

impl Stream<UniLocal, H3>

pub fn write_frame<W>( &mut self, frame: Frame<'_>, bytes_writer: &mut W, ) -> Result<(), EndOfBuffer>

where W: BytesWriter,

See Frame::write.

Panics

Panics if the stream kind is StreamKind::WebTransport. In that case, use upgrade method.

pub async fn write_frame_async<W>( &mut self, frame: Frame<'_>, writer: &mut W, ) -> Result<(), IoWriteError>

where W: AsyncWrite + Unpin + ?Sized,

See Frame::write_async.

Panics

Panics if the stream kind is StreamKind::WebTransport. In that case, use upgrade method.

pub fn write_frame_to_buffer( &mut self, frame: Frame<'_>, buffer_writer: &mut BufferWriter<'_>, ) -> Result<(), EndOfBuffer>

See Frame::write_to_buffer.

Panics

Panics if the stream kind is StreamKind::WebTransport. In that case, use upgrade method.

pub fn upgrade(self) -> StreamUniLocalWT

Upgrades to a WebTransport stream.

Panics

Panics if the stream kind is not StreamKind::WebTransport.

pub fn kind(&self) -> StreamKind

Returns the StreamKind associated with the stream.

pub fn session_id(&self) -> Option<SessionId>

Returns the SessionId if stream is StreamKind::WebTransport, otherwise returns None.

impl Stream<UniLocal, WT>

pub fn session_id(&self) -> SessionId

Returns the SessionId associated with this stream.

impl Stream<Bi, Session>

pub fn read_frame<'a, R>( &self, bytes_reader: &mut R, ) -> Result<Option<Frame<'a>>, ErrorCode>

where R: BytesReader<'a>,

See Frame::read.

pub async fn read_frame_async<'a, R>( &self, reader: &mut R, ) -> Result<Frame<'a>, IoReadError>

where R: AsyncRead + Unpin + ?Sized,

See Frame::read_async.

pub fn read_frame_from_buffer<'a>( &self, buffer_reader: &mut BufferReader<'a>, ) -> Result<Option<Frame<'a>>, ErrorCode>

See Frame::read_from_buffer.

pub fn write_frame<W>( &self, frame: Frame<'_>, bytes_writer: &mut W, ) -> Result<(), EndOfBuffer>

where W: BytesWriter,

See Frame::write.

pub async fn write_frame_async<W>( &self, frame: Frame<'_>, writer: &mut W, ) -> Result<(), IoWriteError>

where W: AsyncWrite + Unpin + ?Sized,

See Frame::write_async.

pub fn write_frame_to_buffer( &self, frame: Frame<'_>, buffer_writer: &mut BufferWriter<'_>, ) -> Result<(), EndOfBuffer>

See Frame::write_to_buffer.

pub fn request(&self) -> &SessionRequest

Returns the SessionRequest associated.

Trait Implementations

impl<K: Debug, S: Debug> Debug for Stream<K, S>

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

Formats the value using the given formatter.