http_body

Struct Frame

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

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

Implementations§

Source§

impl<T> Frame<T>

Source

pub fn data(buf: T) -> Self

Create a DATA frame with the provided Buf.

Source

pub fn trailers(map: HeaderMap) -> Self

Create a trailers frame.

Source

pub fn map_data<F, D>(self, f: F) -> Frame<D>
where F: FnOnce(T) -> D,

Maps this frame’s data to a different type.

Source

pub fn is_data(&self) -> bool

Returns whether this is a DATA frame.

Source

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.

Source

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.

Source

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.

Source

pub fn is_trailers(&self) -> bool

Returns whether this is a trailers frame.

Source

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.

Source

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.

Source

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§

Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Frame<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Frame<T>
where T: RefUnwindSafe,

§

impl<T> Send for Frame<T>
where T: Send,

§

impl<T> Sync for Frame<T>
where T: Sync,

§

impl<T> Unpin for Frame<T>
where T: Unpin,

§

impl<T> UnwindSafe for Frame<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.