Struct poem::Body

source [−]

pub struct Body(_);

Expand description

A body object for requests and responses.

Implementations

source

impl Body

source

pub fn from_bytes(data: Bytes) -> Self

Create a body object from Bytes.

source

pub fn from_string(data: String) -> Self

Create a body object from String.

source

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

Create a body object from Vec<u8>.

source

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

Create a body object from reader.

source

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

Create a body object from bytes stream.

source

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

Create a body object from JSON.

source

pub fn empty() -> Self

Create an empty body.

source

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

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

source

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

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

source

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

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

source

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

Consumes this body object and parse it as T.

Errors

source

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

Consumes this body object to return a reader.

source

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

source

impl Debug for Body

source

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

Formats the value using the given formatter. Read more

source

impl Default for Body

source

fn default() -> Body

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

source

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

source

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

Performs the conversion.

source

impl From<&'static str> for Body

source

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

Performs the conversion.

source

impl From<()> for Body

source

fn from(_: ()) -> Self

Performs the conversion.

source

impl From<Body> for Body

source

fn from(body: Body) -> Self

Performs the conversion.

source

impl From<Body> for Body

source

fn from(body: Body) -> Self

Performs the conversion.

source

impl From<Bytes> for Body

source

fn from(data: Bytes) -> Self

Performs the conversion.

source

impl From<String> for Body

source

fn from(data: String) -> Self

Performs the conversion.

source

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

source

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

Performs the conversion.

source

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

source

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.

source

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

source

impl IntoResponse for Body

source

fn into_response(self) -> Response

Consume itself and return Response.

source

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

source

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

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

source

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

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> FutureExt for T

source

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

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

source

fn with_current_context(self) -> WithContext<Self>

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

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

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

source

pub fn into(self) -> U

Performs the conversion.

source

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

source

pub fn into_result(Self) -> Result<T, Error>

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct poem::Body

Implementations

impl Body

pub fn from_bytes(data: Bytes) -> Self

pub fn from_string(data: String) -> Self

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

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

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

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

pub fn empty() -> Self

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

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

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

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

Errors

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

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

Trait Implementations

impl Debug for Body

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

impl Default for Body

fn default() -> Body

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

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

impl From<&'static str> for Body

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

impl From<()> for Body

fn from(_: ()) -> Self

impl From<Body> for Body

fn from(body: Body) -> Self

impl From<Body> for Body

fn from(body: Body) -> Self

impl From<Bytes> for Body

fn from(data: Bytes) -> Self

impl From<String> for Body

fn from(data: String) -> Self

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

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

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,

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,

impl IntoResponse for Body

fn into_response(self) -> Response

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

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

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

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 T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> FutureExt for T

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

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

pub fn into_result(Self) -> Result<T, Error>

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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,

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,

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

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

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

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

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

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

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

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

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

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

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

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