Struct poem_openapi::payload::Binary

source · 
pub struct Binary<T>(pub T);
Expand description

A binary payload.

Examples

use poem::{
    error::BadRequest,
    http::{Method, StatusCode, Uri},
    test::TestClient,
    Body, IntoEndpoint, Request, Result,
};
use poem_openapi::{
    payload::{Binary, 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<Body>) -> 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");
let cli = TestClient::new(api);

let resp = cli
    .post("/upload")
    .content_type("application/octet-stream")
    .body("abcdef")
    .send()
    .await;
resp.assert_status_is_ok();
resp.assert_text("6").await;

let resp = cli
    .post("/upload_stream")
    .content_type("application/octet-stream")
    .body("abcdef")
    .send()
    .await;
resp.assert_status_is_ok();
resp.assert_text("6").await;

Tuple Fields§

§0: T

Trait Implementations§

source§

impl<'a> ApiExtractor<'a> for Binary<Body>

source§

const TYPE: ApiExtractorType = crate::ApiExtractorType::RequestObject

The type of API extractor.
§

type ParamType = ()

The parameter type.
§

type ParamRawType = ()

The raw parameter type for validators.
source§

fn register(registry: &mut Registry)

Register related types to registry.
source§

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.
source§

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

Parse from the HTTP request.
source§

const PARAM_IS_REQUIRED: bool = false

If it is true, it means that this parameter is required.
source§

fn security_scheme() -> Option<&'static str>

Returns name of security scheme if this extractor is security scheme.
source§

fn param_in() -> Option<MetaParamIn>

Returns the location of the parameter if this extractor is parameter.
source§

fn param_schema_ref() -> Option<MetaSchemaRef>

Returns the schema of the parameter if this extractor is parameter.
source§

fn param_raw_type(&self) -> Option<&Self::ParamRawType>

Returns a reference to the raw type of this parameter.
source§

impl<'a> ApiExtractor<'a> for Binary<Bytes>

source§

const TYPE: ApiExtractorType = crate::ApiExtractorType::RequestObject

The type of API extractor.
§

type ParamType = ()

The parameter type.
§

type ParamRawType = ()

The raw parameter type for validators.
source§

fn register(registry: &mut Registry)

Register related types to registry.
source§

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.
source§

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

Parse from the HTTP request.
source§

const PARAM_IS_REQUIRED: bool = false

If it is true, it means that this parameter is required.
source§

fn security_scheme() -> Option<&'static str>

Returns name of security scheme if this extractor is security scheme.
source§

fn param_in() -> Option<MetaParamIn>

Returns the location of the parameter if this extractor is parameter.
source§

fn param_schema_ref() -> Option<MetaSchemaRef>

Returns the schema of the parameter if this extractor is parameter.
source§

fn param_raw_type(&self) -> Option<&Self::ParamRawType>

Returns a reference to the raw type of this parameter.
source§

impl<'a> ApiExtractor<'a> for Binary<Vec<u8>>

source§

const TYPE: ApiExtractorType = crate::ApiExtractorType::RequestObject

The type of API extractor.
§

type ParamType = ()

The parameter type.
§

type ParamRawType = ()

The raw parameter type for validators.
source§

fn register(registry: &mut Registry)

Register related types to registry.
source§

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.
source§

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

Parse from the HTTP request.
source§

const PARAM_IS_REQUIRED: bool = false

If it is true, it means that this parameter is required.
source§

fn security_scheme() -> Option<&'static str>

Returns name of security scheme if this extractor is security scheme.
source§

fn param_in() -> Option<MetaParamIn>

Returns the location of the parameter if this extractor is parameter.
source§

fn param_schema_ref() -> Option<MetaSchemaRef>

Returns the schema of the parameter if this extractor is parameter.
source§

fn param_raw_type(&self) -> Option<&Self::ParamRawType>

Returns a reference to the raw type of this parameter.
source§

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

source§

fn meta() -> MetaResponses

Gets metadata of this response.
source§

fn register(_registry: &mut Registry)

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

const BAD_REQUEST_HANDLER: bool = false

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

fn from_parse_request_error(err: Error) -> Self

Convert poem::Error to this response object.
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Deref for Binary<T>

§

type Target = T

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<T> DerefMut for Binary<T>

source§

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

Mutably dereferences the value.
source§

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

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_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
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
source§

impl ParsePayload for Binary<Body>

source§

const IS_REQUIRED: bool = true

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

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

Parse the payload object from the HTTP request.
source§

impl ParsePayload for Binary<Bytes>

source§

const IS_REQUIRED: bool = true

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

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

Parse the payload object from the HTTP request.
source§

impl ParsePayload for Binary<Vec<u8>>

source§

const IS_REQUIRED: bool = true

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

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

Parse the payload object from the HTTP request.
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

const CONTENT_TYPE: &'static str = "application/octet-stream"

The content type of this payload.
source§

fn check_content_type(content_type: &str) -> bool

Check the content type of incoming request
source§

fn schema_ref() -> MetaSchemaRef

Gets schema reference of this payload.
source§

fn register(registry: &mut Registry)

Register the schema contained in this payload to the registry.
source§

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

source§

impl<T> StructuralEq for Binary<T>

source§

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§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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
source§

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

source§

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

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

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

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

source§

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

source§

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> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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.
source§

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

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
source§

impl<T> Formattable for Twhere
    T: Deref,
    <T as Deref>::Target: Formattable,

source§

impl<T> Parsable for Twhere
    T: Deref,
    <T as Deref>::Target: Parsable,