Struct ResponseBody 

pub struct ResponseBody<B = BoxBody> { /* private fields */ }

A unified response body type. Generic type is for custom pinned response body(type implement Body).

Implementations

impl ResponseBody

pub fn boxed<B, T, E>(body: B) -> ResponseBody

where B: Body<Data = T, Error = E> + 'static, T: Into<Bytes> + 'static, E: Into<Box<dyn Error + Sync + Send>> + 'static,

Construct a new Body variant of ResponseBody with default type as BoxBody

impl<B> ResponseBody<B>

pub const fn empty() -> ResponseBody<B>

indicate empty body is attached to response. content-length: 0 header would be added to response when [BodySize] is used for inferring response body type.

pub const fn body(stream: B) -> ResponseBody<B>

Construct a new Body variant of ResponseBody

pub fn bytes<B2>(bytes: B2) -> ResponseBody<B>

where Bytes: From<B2>,

Construct a new Bytes variant of ResponseBody

pub fn into_boxed<T, E>(self) -> ResponseBody

where B: Body<Data = T, Error = E> + 'static, T: Into<Bytes> + Buf + 'static, E: Error + Send + Sync + 'static,

erase generic body type by boxing the variant.

Trait Implementations

impl<B, E> Body for ResponseBody<B>

where B: Body<Data = Bytes, Error = E>,

type Data = Bytes

The payload data type yielded by Frame::Data variants.

type Error = E

The error type that can occur while producing frames.

fn poll_frame( self: Pin<&mut ResponseBody<B>>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Bytes>, E>>>

Attempt to pull the next frame from the body.

fn is_end_stream(&self) -> bool

Indicates whether the body has been fully consumed.

fn size_hint(&self) -> SizeHint

Returns a hint about the total size of the remaining Frame::Data payload.

impl<B> Default for ResponseBody<B>

fn default() -> ResponseBody<B>

Returns the “default value” for a type.

impl<B> From<&'static [u8]> for ResponseBody<B>

fn from(item: &'static [u8]) -> ResponseBody<B>

Converts to this type from the input type.

impl<B> From<&'static str> for ResponseBody<B>

fn from(item: &'static str) -> ResponseBody<B>

Converts to this type from the input type.

impl<B> From<Box<[u8]>> for ResponseBody<B>

fn from(item: Box<[u8]>) -> ResponseBody<B>

Converts to this type from the input type.

impl<B> From<Box<str>> for ResponseBody<B>

fn from(str: Box<str>) -> ResponseBody<B>

Converts to this type from the input type.

impl From<BoxBody> for ResponseBody

fn from(body: BoxBody) -> ResponseBody

Converts to this type from the input type.

impl<B> From<Bytes> for ResponseBody<B>

fn from(item: Bytes) -> ResponseBody<B>

Converts to this type from the input type.

impl<B> From<BytesMut> for ResponseBody<B>

fn from(item: BytesMut) -> ResponseBody<B>

Converts to this type from the input type.

impl<B> From<Cow<'static, str>> for ResponseBody<B>

fn from(str: Cow<'static, str>) -> ResponseBody<B>

Converts to this type from the input type.

impl<B> From<ResponseBody> for CompatBody<B>

where B: From<ResponseBody>,

fn from(body: ResponseBody) -> Self

Converts to this type from the input type.

impl<B> From<String> for ResponseBody<B>

fn from(item: String) -> ResponseBody<B>

Converts to this type from the input type.

impl<B> From<Vec<u8>> for ResponseBody<B>

fn from(item: Vec<u8>) -> ResponseBody<B>

Converts to this type from the input type.

impl<'r, C, B, ResB> Responder<WebContext<'r, C, B>> for ResponseBody<ResB>

type Response = Response<ResponseBody<ResB>>

type Error = Error

async fn respond( self, ctx: WebContext<'r, C, B>, ) -> Result<Self::Response, Self::Error>

generate response from given request.

fn map(self, res: Self::Response) -> Result<Self::Response, Self::Error>

map response type and mutate it’s state. default to pass through without any modification.

impl<'__pin, B> Unpin for ResponseBody<B>

where <PinnedFieldsOfHelperStruct<__Origin<'__pin, B>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,