poem_openapi/payload/
xml.rs

1use std::ops::{Deref, DerefMut};
2
3use poem::{FromRequest, IntoResponse, Request, RequestBody, Response, Result};
4use serde_json::Value;
5
6use crate::{
7    error::ParseRequestPayloadError,
8    payload::{ParsePayload, Payload},
9    registry::{MetaMediaType, MetaResponse, MetaResponses, MetaSchemaRef, Registry},
10    types::{ParseFromXML, ToXML, Type},
11    ApiResponse,
12};
13
14/// A XML payload.
15#[derive(Debug, Clone, Eq, PartialEq)]
16pub struct Xml<T>(pub T);
17
18impl<T> Deref for Xml<T> {
19    type Target = T;
20
21    fn deref(&self) -> &Self::Target {
22        &self.0
23    }
24}
25
26impl<T> DerefMut for Xml<T> {
27    fn deref_mut(&mut self) -> &mut Self::Target {
28        &mut self.0
29    }
30}
31
32impl<T: Type> Payload for Xml<T> {
33    const CONTENT_TYPE: &'static str = "application/xml; charset=utf-8";
34
35    fn check_content_type(content_type: &str) -> bool {
36        matches!(content_type.parse::<mime::Mime>(), Ok(content_type) if content_type.type_() == "application"
37                && (content_type.subtype() == "xml"
38                || content_type
39                    .suffix()
40                    .is_some_and(|v| v == "xml")))
41    }
42
43    fn schema_ref() -> MetaSchemaRef {
44        T::schema_ref()
45    }
46
47    #[allow(unused_variables)]
48    fn register(registry: &mut Registry) {
49        T::register(registry);
50    }
51}
52
53impl<T: ParseFromXML> ParsePayload for Xml<T> {
54    const IS_REQUIRED: bool = true;
55
56    async fn from_request(request: &Request, body: &mut RequestBody) -> Result<Self> {
57        let data = Vec::<u8>::from_request(request, body).await?;
58        let value = if data.is_empty() {
59            Value::Null
60        } else {
61            quick_xml::de::from_str(&String::from_utf8(data).unwrap_or_default()).map_err(
62                |err| ParseRequestPayloadError {
63                    reason: err.to_string(),
64                },
65            )?
66        };
67
68        let value = T::parse_from_xml(Some(value)).map_err(|err| ParseRequestPayloadError {
69            reason: err.into_message(),
70        })?;
71        Ok(Self(value))
72    }
73}
74
75impl<T: ToXML> IntoResponse for Xml<T> {
76    fn into_response(self) -> Response {
77        poem::web::Xml(self.0.to_xml()).into_response()
78    }
79}
80
81impl<T: ToXML> ApiResponse for Xml<T> {
82    fn meta() -> MetaResponses {
83        MetaResponses {
84            responses: vec![MetaResponse {
85                description: "",
86                status: Some(200),
87                content: vec![MetaMediaType {
88                    content_type: Self::CONTENT_TYPE,
89                    schema: Self::schema_ref(),
90                }],
91                headers: vec![],
92            }],
93        }
94    }
95
96    fn register(registry: &mut Registry) {
97        T::register(registry);
98    }
99}
100
101impl_apirequest_for_payload!(Xml<T>, T: ParseFromXML);
poem_openapi/payload/xml.rs

poem_openapi/payload/
xml.rs
