poem_openapi/payload/
binary.rs

1use std::ops::{Deref, DerefMut};
2
3use bytes::Bytes;
4use poem::{Body, FromRequest, IntoResponse, Request, RequestBody, Response, Result};
5
6use crate::{
7    payload::{ParsePayload, Payload},
8    registry::{MetaMediaType, MetaResponse, MetaResponses, MetaSchema, MetaSchemaRef, Registry},
9    ApiResponse,
10};
11
12/// A binary payload.
13///
14/// # Examples
15///
16/// ```rust
17/// use poem::{
18///     error::BadRequest,
19///     http::{Method, StatusCode, Uri},
20///     test::TestClient,
21///     Body, IntoEndpoint, Request, Result,
22/// };
23/// use poem_openapi::{
24///     payload::{Binary, Json},
25///     OpenApi, OpenApiService,
26/// };
27/// use tokio::io::AsyncReadExt;
28///
29/// struct MyApi;
30///
31/// #[OpenApi]
32/// impl MyApi {
33///     #[oai(path = "/upload", method = "post")]
34///     async fn upload_binary(&self, data: Binary<Vec<u8>>) -> Json<usize> {
35///         Json(data.len())
36///     }
37///
38///     #[oai(path = "/upload_stream", method = "post")]
39///     async fn upload_binary_stream(&self, data: Binary<Body>) -> Result<Json<usize>> {
40///         let mut reader = data.0.into_async_read();
41///         let mut bytes = Vec::new();
42///         reader.read_to_end(&mut bytes).await.map_err(BadRequest)?;
43///         Ok(Json(bytes.len()))
44///     }
45/// }
46///
47/// let api = OpenApiService::new(MyApi, "Demo", "0.1.0");
48/// let cli = TestClient::new(api);
49///
50/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
51/// let resp = cli
52///     .post("/upload")
53///     .content_type("application/octet-stream")
54///     .body("abcdef")
55///     .send()
56///     .await;
57/// resp.assert_status_is_ok();
58/// resp.assert_text("6").await;
59///
60/// let resp = cli
61///     .post("/upload_stream")
62///     .content_type("application/octet-stream")
63///     .body("abcdef")
64///     .send()
65///     .await;
66/// resp.assert_status_is_ok();
67/// resp.assert_text("6").await;
68/// # });
69/// ```
70#[derive(Debug, Clone, Eq, PartialEq)]
71pub struct Binary<T>(pub T);
72
73impl<T> Deref for Binary<T> {
74    type Target = T;
75
76    fn deref(&self) -> &Self::Target {
77        &self.0
78    }
79}
80
81impl<T> DerefMut for Binary<T> {
82    fn deref_mut(&mut self) -> &mut Self::Target {
83        &mut self.0
84    }
85}
86
87impl<T: Send> Payload for Binary<T> {
88    const CONTENT_TYPE: &'static str = "application/octet-stream";
89
90    fn check_content_type(content_type: &str) -> bool {
91        matches!(content_type.parse::<mime::Mime>(), Ok(content_type) if content_type.type_() == "application"
92                && (content_type.subtype() == "octet-stream"
93                || content_type
94                    .suffix()
95                    .is_some_and(|v| v == "octet-stream")))
96    }
97
98    fn schema_ref() -> MetaSchemaRef {
99        MetaSchemaRef::Inline(Box::new(MetaSchema {
100            format: Some("binary"),
101            ..MetaSchema::new("string")
102        }))
103    }
104}
105
106impl ParsePayload for Binary<Vec<u8>> {
107    const IS_REQUIRED: bool = true;
108
109    async fn from_request(request: &Request, body: &mut RequestBody) -> Result<Self> {
110        Ok(Self(<Vec<u8>>::from_request(request, body).await?))
111    }
112}
113
114impl ParsePayload for Binary<Bytes> {
115    const IS_REQUIRED: bool = true;
116
117    async fn from_request(request: &Request, body: &mut RequestBody) -> Result<Self> {
118        Ok(Self(Bytes::from_request(request, body).await?))
119    }
120}
121
122impl ParsePayload for Binary<Body> {
123    const IS_REQUIRED: bool = true;
124
125    async fn from_request(request: &Request, body: &mut RequestBody) -> Result<Self> {
126        Ok(Self(Body::from_request(request, body).await?))
127    }
128}
129
130impl<T: Into<Body> + Send> IntoResponse for Binary<T> {
131    fn into_response(self) -> Response {
132        Response::builder()
133            .content_type(Self::CONTENT_TYPE)
134            .body(self.0.into())
135    }
136}
137
138impl<T: Into<Body> + Send> ApiResponse for Binary<T> {
139    fn meta() -> MetaResponses {
140        MetaResponses {
141            responses: vec![MetaResponse {
142                description: "",
143                status: Some(200),
144                status_range: None,
145                content: vec![MetaMediaType {
146                    content_type: Self::CONTENT_TYPE,
147                    schema: Self::schema_ref(),
148                }],
149                headers: vec![],
150            }],
151        }
152    }
153
154    fn register(_registry: &mut Registry) {}
155}
156
157impl_apirequest_for_payload!(Binary<Vec<u8>>);
158impl_apirequest_for_payload!(Binary<Bytes>);
159impl_apirequest_for_payload!(Binary<Body>);
poem_openapi/payload/binary.rs

poem_openapi/payload/
binary.rs
