Struct Frame 

pub struct Frame<'a> { /* private fields */ }

An HTTP3 frame.

Implementations

impl<'a> Frame<'a>

pub fn new_headers(payload: Cow<'a, [u8]>) -> Self

Creates a new frame of type FrameKind::Headers.

Panics

Panics if the payload size if greater than VarInt::MAX.

pub fn new_settings(payload: Cow<'a, [u8]>) -> Self

Creates a new frame of type FrameKind::Settings.

Panics

Panics if the payload size if greater than VarInt::MAX.

pub fn new_webtransport(session_id: SessionId) -> Self

Creates a new frame of type FrameKind::WebTransport.

pub fn new_data(payload: Cow<'a, [u8]>) -> Self

Creates a new frame of type FrameKind::Data.

Panics

Panics if the payload size if greater than VarInt::MAX.

pub fn new_exercise(id: VarInt, payload: Cow<'a, [u8]>) -> Self

Creates a new frame of type FrameKind::Exercise.

Panics

• Panics if the payload size if greater than VarInt::MAX.
• Panics if id is not a valid exercise (see FrameKind::is_id_exercise).

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

where R: BytesReader<'a>,

Reads a Frame from a BytesReader.

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

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

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

where R: AsyncRead + Unpin + ?Sized,

Reads a Frame from a reader.

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

Reads a Frame from a BufferReader.

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

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 Frame into a BytesWriter.

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

In case Err, bytes_writer might be partially written.

Panics

Panics if the payload size if greater than VarInt::MAX.

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

where W: AsyncWrite + Unpin + ?Sized,

Writes a Frame into a writer.

Panics

Panics if the payload size if greater than VarInt::MAX.

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

Writes this Frame into a buffer via BufferWriter.

In case Err, buffer_writer is not advanced.

Panics

Panics if the payload size if greater than VarInt::MAX.

pub fn write_size(&self) -> usize

Returns the needed capacity to write this frame into a buffer.

pub const fn kind(&self) -> FrameKind

Returns the FrameKind of this Frame.

pub fn payload(&self) -> &[u8]

Returns the payload of this Frame.

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

Returns the SessionId if frame is FrameKind::WebTransport, otherwise returns None.

Trait Implementations

impl<'a> Debug for Frame<'a>

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

Formats the value using the given formatter.