Struct StreamHeader 

pub struct StreamHeader { /* private fields */ }

HTTP3 stream type.

Unidirectional HTTP3 streams have an header encoding the type.

Implementations

impl StreamHeader

pub const MAX_SIZE: usize = 16usize

Maximum number of bytes a StreamHeader can take over network.

pub fn new_control() -> Self

Creates a new stream header of type StreamKind::Control.

pub fn new_webtransport(session_id: SessionId) -> Self

Creates a new stream header of type StreamKind::WebTransport.

pub fn read<'a, R>(bytes_reader: &mut R) -> Result<Option<Self>, ParseError>

where R: BytesReader<'a>,

Reads a StreamHeader from a BytesReader.

It returns None if the bytes_reader does not contain enough bytes to parse an entire header.

In case None or Err, bytes_reader might be partially read.

pub async fn read_async<R>(reader: &mut R) -> Result<Self, IoReadError>

where R: AsyncRead + Unpin + ?Sized,

Reads a StreamHeader from a reader.

pub fn read_from_buffer( buffer_reader: &mut BufferReader<'_>, ) -> Result<Option<Self>, ParseError>

Reads a StreamHeader from a BufferReader.

It returns None if the buffer_reader does not contain enough bytes to parse an entire header.

In case None or Err, buffer_reader offset if not advanced.

pub fn write<W>(&self, bytes_writer: &mut W) -> Result<(), EndOfBuffer>

where W: BytesWriter,

Writes a StreamHeader into a BytesWriter.

It returns Err if the bytes_writer does not have enough capacity to write the entire header. See Self::write_size to retrieve the exact amount of required capacity.

In case Err, bytes_writer might be partially written.

pub async fn write_async<W>(&self, writer: &mut W) -> Result<(), IoWriteError>

where W: AsyncWrite + Unpin + ?Sized,

Writes a StreamHeader into a writer.

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

Writes this StreamHeader into a buffer via BufferWriter.

In case Err, buffer_writer is not advanced.

pub fn write_size(&self) -> usize

Returns the needed capacity to write this stream header into a buffer.

pub const fn kind(&self) -> StreamKind

Returns the StreamKind.

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

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