Struct poem::Body

source · [−]

pub struct Body(_);

Expand description

A body object for requests and responses.

Implementations

impl Body

pub fn from_bytes(data: Bytes) -> Self

Create a body object from Bytes.

pub fn from_string(data: String) -> Self

Create a body object from String.

pub fn from_vec(data: Vec<u8>) -> Self

Create a body object from Vec<u8>.

pub fn from_async_read(reader: impl AsyncRead + Send + 'static) -> Self

Create a body object from reader.

pub fn from_bytes_stream<S, O, E>(stream: S) -> Selfwhere
    S: Stream<Item = Result<O, E>> + Send + 'static,
    O: Into<Bytes> + 'static,
    E: Error + Send + Sync + 'static,

Create a body object from bytes stream.

pub fn from_json(body: impl Serialize) -> Result<Self>

Create a body object from JSON.

pub fn empty() -> Self

Create an empty body.

pub fn is_empty(&self) -> bool

Returns true if this body is empty.

pub async fn into_bytes(self) -> Result<Bytes, ReadBodyError>

Consumes this body object to return a Bytes that contains all data.

pub async fn into_vec(self) -> Result<Vec<u8>, ReadBodyError>

Consumes this body object to return a Vec<u8> that contains all data.

pub async fn into_bytes_limit(self, limit: usize) -> Result<Bytes, ReadBodyError>

Consumes this body object to return a Bytes that contains all data, returns Err(ReadBodyError::PayloadTooLarge) if the length of the payload exceeds limit.

Example

use poem::{error::ReadBodyError, handler, http::StatusCode, Body, Endpoint, Request, Result};

#[handler]
async fn index(data: Body) -> Result<()> {
    Ok(data.into_bytes_limit(5).await.map(|_| ())?)
}

let req = Request::builder().body("12345");
assert_eq!(index.get_response(req).await.status(), StatusCode::OK);

let req = Request::builder().body("123456");
assert_eq!(
    index.get_response(req).await.status(),
    StatusCode::PAYLOAD_TOO_LARGE
);

pub async fn into_string(self) -> Result<String, ReadBodyError>

Consumes this body object to return a String that contains all data.

pub async fn into_json<T: DeserializeOwned>(self) -> Result<T>

Consumes this body object and parse it as T.

Errors

pub async fn into_xml<T: DeserializeOwned>(self) -> Result<T>

Consumes this body object and parse it as T.

Errors

pub fn into_async_read(self) -> impl AsyncRead + Unpin + Send + 'static

Consumes this body object to return a reader.

pub fn into_bytes_stream(
self
) -> impl Stream<Item = Result<Bytes, IoError>> + Send + 'static

Consumes this body object to return a bytes stream.

Trait Implementations

impl Debug for Body

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

Formats the value using the given formatter. Read more

impl Default for Body

fn default() -> Body

Returns the “default value” for a type. Read more

impl From<&'static [u8]> for Body

fn from(data: &'static [u8]) -> Self

Converts to this type from the input type.

impl From<&'static str> for Body

fn from(data: &'static str) -> Self

Converts to this type from the input type.

impl From<()> for Body

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<Body> for Body

fn from(body: Body) -> Self

Converts to this type from the input type.

impl From<Body> for Body

fn from(body: Body) -> Self

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(data: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for Body

fn from(data: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for Body

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

impl<'a> FromRequest<'a> for Body

fn from_request<'life0, 'async_trait>(
    _req: &'a Request,
    body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait,

Extract from request head and body.

fn from_request_without_body<'async_trait>(
    req: &'a Request
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where
    'a: 'async_trait,
    Self: Send + 'async_trait,

Extract from request head. Read more

impl IntoResponse for Body

fn into_response(self) -> Response

Consume itself and return Response.

fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self>where
    K: TryInto<HeaderName>,
    V: TryInto<HeaderValue>,
    Self: Sized,

Wrap an impl IntoResponse to add a header. Read more

fn with_content_type<V>(self, content_type: V) -> WithContentType<Self>where
V: TryInto<HeaderValue>,
Self: Sized,

Wrap an impl IntoResponse to with a new content type. Read more

fn with_status(self, status: StatusCode) -> WithStatus<Self>where
Self: Sized,

Wrap an impl IntoResponse to set a status code. Read more

fn with_body(self, body: impl Into<Body>) -> WithBody<Self>where
Self: Sized,

Wrap an impl IntoResponse to set a body. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Body

impl Send for Body

impl Sync for Body

impl Unpin for Body

impl !UnwindSafe for Body

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,

fn implicit(
    self,
    class: Class,
    constructed: bool,
    tag: u32
) -> TaggedParser<'a, Implicit, Self>

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

const: unstable · 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.

impl<T> IntoResult<T> for Twhere
T: IntoResponse,

fn into_result(self) -> Result<T, Error>

Consumes this value returns a poem::Result<T>.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more