Struct poem_openapi::payload::Base64

pub struct Base64<T>(pub T);

A binary payload encoded with base64.

Examples

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

#[derive(Default)]
struct MyApi {
    data: Mutex<Vec<u8>>,
}

#[OpenApi]
impl MyApi {
    #[oai(path = "/upload", method = "post")]
    async fn upload_binary(&self, data: Base64<Vec<u8>>) -> Json<usize> {
        let len = data.len();
        assert_eq!(data.0, b"abcdef");
        *self.data.lock().await = data.0;
        Json(len)
    }

    #[oai(path = "/download", method = "get")]
    async fn download_binary(&self) -> Base64<Vec<u8>> {
        Base64(self.data.lock().await.clone())
    }
}

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

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

let resp = api
    .call(
        Request::builder()
            .method(Method::GET)
            .uri(Uri::from_static("/download"))
            .finish(),
    )
    .await
    .unwrap();
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.into_body().into_string().await.unwrap(), "YWJjZGVm");

Tuple Fields

0: T

Trait Implementations

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

const TYPE: ApiExtractorType

The type of API extractor.

type ParamType = ()

The parameter type.

type ParamRawType = ()

The raw parameter type for validators.

fn register(registry: &mut Registry)

Register related types to registry.

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.

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
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Parse from the HTTP request.

const PARAM_IS_REQUIRED: bool

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

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

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

fn param_in() -> Option<MetaParamIn>

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

fn param_schema_ref() -> Option<MetaSchemaRef>

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

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

Returns a reference to the raw type of this parameter.

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

const TYPE: ApiExtractorType

The type of API extractor.

type ParamType = ()

The parameter type.

type ParamRawType = ()

The raw parameter type for validators.

fn register(registry: &mut Registry)

Register related types to registry.

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.

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
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Parse from the HTTP request.

const PARAM_IS_REQUIRED: bool

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

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

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

fn param_in() -> Option<MetaParamIn>

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

fn param_schema_ref() -> Option<MetaSchemaRef>

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

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

Returns a reference to the raw type of this parameter.

impl<T: AsRef<[u8]> + Send> ApiResponse for Base64<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.

fn from_parse_request_error(err: Error) -> Self

Convert poem::Error to this response object.

impl<T: Clone> Clone for Base64<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Base64<T>

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

Formats the value using the given formatter.

impl<T> Deref for Base64<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Base64<T>

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

Mutably dereferences the value.

impl<T: AsRef<[u8]> + Send> IntoResponse for Base64<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.

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

Wrap an impl IntoResponse to with a new content type.

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

Wrap an impl IntoResponse to set a status code.

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

Wrap an impl IntoResponse to set a body.

impl ParsePayload for Base64<Vec<u8>>

const IS_REQUIRED: bool

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

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
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Parse the payload object from the HTTP request.

impl ParsePayload for Base64<Bytes>

const IS_REQUIRED: bool

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

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
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Parse the payload object from the HTTP request.

impl<T: PartialEq> PartialEq<Base64<T>> for Base64<T>

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

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

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

This method tests for !=.

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

const CONTENT_TYPE: &'static str

The content type of this payload.

fn schema_ref() -> MetaSchemaRef

Gets schema reference of this payload.

fn register(registry: &mut Registry)

Register the schema contained in this payload to the registry.

impl<T: Eq> Eq for Base64<T>

impl<T> StructuralEq for Base64<T>

impl<T> StructuralPartialEq for Base64<T>