Struct poem_openapi::payload::Binary[−][src]

pub struct Binary<T>(pub T);

Expand description

A binary payload.

Examples

use poem::{
    error::BadRequest,
    http::{Method, StatusCode, Uri},
    IntoEndpoint, Request, Result,
};
use poem_openapi::{
    payload::{Binary, BinaryStream, Json},
    OpenApi, OpenApiService,
};
use tokio::io::AsyncReadExt;

struct MyApi;

#[OpenApi]
impl MyApi {
    #[oai(path = "/upload", method = "post")]
    async fn upload_binary(&self, data: Binary<Vec<u8>>) -> Json<usize> {
        Json(data.len())
    }

    #[oai(path = "/upload_stream", method = "post")]
    async fn upload_binary_stream(&self, data: Binary<BinaryStream>) -> Result<Json<usize>> {
        let mut reader = data.0.into_async_read();
        let mut bytes = Vec::new();
        reader.read_to_end(&mut bytes).await.map_err(BadRequest)?;
        Ok(Json(bytes.len()))
    }
}

let api = OpenApiService::new(MyApi, "Demo", "0.1.0").into_endpoint();

let resp = api
    .call(
        Request::builder()
            .method(Method::POST)
            .content_type("application/octet-stream")
            .uri(Uri::from_static("/upload"))
            .body("abcdef"),
    )
    .await;
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.into_body().into_string().await.unwrap(), "6");

let resp = api
    .call(
        Request::builder()
            .method(Method::POST)
            .content_type("application/octet-stream")
            .uri(Uri::from_static("/upload_stream"))
            .body("abcdef"),
    )
    .await;
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.into_body().into_string().await.unwrap(), "6");

Tuple Fields

0: T

Trait Implementations

impl<T: Into<Body> + Send> ApiResponse for Binary<T>

fn meta() -> MetaResponses

Gets metadata of this response.

fn register(_registry: &mut Registry)

Register the schema contained in this response object to the registry.

const BAD_REQUEST_HANDLER: bool

If true, it means that the response object has a custom bad request handler. Read more

fn from_parse_request_error(err: ParseRequestError) -> Self

Convert ParseRequestError to this response object.

impl<T: Clone> Clone for Binary<T>

fn clone(&self) -> Binary<T>

Returns a copy of the value. Read more

1.0.0[src]

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for Binary<T>

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

Formats the value using the given formatter. Read more

impl<T> Deref for Binary<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Binary<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Into<Body> + Send> IntoResponse for Binary<T>

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>,

Wrap an impl IntoResponse to add a header. Read more

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

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

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

Wrap an impl IntoResponse to set a body. Read more

impl ParsePayload for Binary<Vec<u8>>

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

Parse the payload object from the HTTP request.

impl ParsePayload for Binary<Bytes>

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

Parse the payload object from the HTTP request.

impl ParsePayload for Binary<BinaryStream>

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

Parse the payload object from the HTTP request.

impl<T: PartialEq> PartialEq<Binary<T>> for Binary<T>

fn eq(&self, other: &Binary<T>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &Binary<T>) -> bool

This method tests for !=.

impl<T: Send> Payload for Binary<T>

const CONTENT_TYPE: &'static str

The content type of this payload.

fn schema_ref() -> MetaSchemaRef

Gets schema reference of this payload.

const IS_REQUIRED: bool

If it is true, it means that this payload is required.

fn register(registry: &mut Registry)

Register the schema contained in this payload to the registry.

impl<T: Eq> Eq for Binary<T>

impl<T> StructuralEq for Binary<T>

impl<T> StructuralPartialEq for Binary<T>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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 T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub 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