Struct http_body::Frame

pub struct Frame<T> { /* private fields */ }

A frame of any kind related to an HTTP stream (body).

Implementations

impl<T> Frame<T>

pub fn data(buf: T) -> Self

Create a DATA frame with the provided Buf.

pub fn trailers(map: HeaderMap) -> Self

Create a trailers frame.

pub fn is_data(&self) -> bool

Returns whether this is a DATA frame.

pub fn into_data(self) -> Result<T, Self>

Consumes self into the buf of the DATA frame.

Returns an Err containing the original Frame when frame is not a DATA frame. Frame::is_data can also be used to determine if the frame is a DATA frame.

pub fn data_ref(&self) -> Option<&T>

If this is a DATA frame, returns a reference to it.

Returns None if not a DATA frame.

pub fn data_mut(&mut self) -> Option<&mut T>

If this is a DATA frame, returns a mutable reference to it.

Returns None if not a DATA frame.

pub fn is_trailers(&self) -> bool

Returns whether this is a trailers frame.

pub fn into_trailers(self) -> Result<HeaderMap, Self>

Consumes self into the buf of the trailers frame.

Returns an Err containing the original Frame when frame is not a trailers frame. Frame::is_trailers can also be used to determine if the frame is a trailers frame.

pub fn trailers_ref(&self) -> Option<&HeaderMap>

If this is a trailers frame, returns a reference to it.

Returns None if not a trailers frame.

pub fn trailers_mut(&mut self) -> Option<&mut HeaderMap>

If this is a trailers frame, returns a mutable reference to it.

Returns None if not a trailers frame.

Trait Implementations

impl<T: Debug> Debug for Frame<T>

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

Formats the value using the given formatter.