yang_base/definition/
media.rs1use schemars::JsonSchema;
4use serde::{Deserialize, Serialize};
5
6pub const DEFAULT_MULTIPART_MAX_FIELDS: u16 = 64;
8pub const DEFAULT_MULTIPART_MAX_FILES: u16 = 8;
10pub const DEFAULT_MULTIPART_MAX_FILE_BYTES: u64 = 10 * 1024 * 1024;
12pub const DEFAULT_MULTIPART_MAX_TEXT_FIELD_BYTES: u64 = 64 * 1024;
14pub const DEFAULT_MULTIPART_MAX_TOTAL_BYTES: u64 = 32 * 1024 * 1024;
16
17#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize, JsonSchema)]
21#[serde(rename_all = "snake_case")]
22#[non_exhaustive]
23pub enum ActionMediaType {
24 Multipart,
26 #[default]
28 #[serde(other)]
29 Json,
30}
31
32#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize, JsonSchema)]
37#[serde(rename_all = "snake_case")]
38#[non_exhaustive]
39pub enum UploadLifecycle {
40 #[default]
42 #[serde(other)]
43 RequestScoped,
44}
45
46#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
52pub struct MultipartSpec {
53 pub max_fields: u16,
55 pub max_files: u16,
57 pub max_file_bytes: u64,
59 pub max_text_field_bytes: u64,
61 pub max_total_bytes: u64,
63 pub allowed_content_types: Vec<String>,
66 pub lifecycle: UploadLifecycle,
68}
69
70impl MultipartSpec {
71 pub fn new<I, S>(allowed_content_types: I) -> Self
73 where
74 I: IntoIterator<Item = S>,
75 S: Into<String>,
76 {
77 Self {
78 max_fields: DEFAULT_MULTIPART_MAX_FIELDS,
79 max_files: DEFAULT_MULTIPART_MAX_FILES,
80 max_file_bytes: DEFAULT_MULTIPART_MAX_FILE_BYTES,
81 max_text_field_bytes: DEFAULT_MULTIPART_MAX_TEXT_FIELD_BYTES,
82 max_total_bytes: DEFAULT_MULTIPART_MAX_TOTAL_BYTES,
83 allowed_content_types: allowed_content_types.into_iter().map(Into::into).collect(),
84 lifecycle: UploadLifecycle::RequestScoped,
85 }
86 }
87
88 #[must_use]
90 pub fn max_fields(mut self, max_fields: u16) -> Self {
91 self.max_fields = max_fields;
92 self
93 }
94
95 #[must_use]
97 pub fn max_files(mut self, max_files: u16) -> Self {
98 self.max_files = max_files;
99 self
100 }
101
102 #[must_use]
104 pub fn max_file_bytes(mut self, max_file_bytes: u64) -> Self {
105 self.max_file_bytes = max_file_bytes;
106 self
107 }
108
109 #[must_use]
111 pub fn max_text_field_bytes(mut self, max_text_field_bytes: u64) -> Self {
112 self.max_text_field_bytes = max_text_field_bytes;
113 self
114 }
115
116 #[must_use]
118 pub fn max_total_bytes(mut self, max_total_bytes: u64) -> Self {
119 self.max_total_bytes = max_total_bytes;
120 self
121 }
122}
123
124#[cfg(test)]
125mod tests {
126 use super::*;
127
128 #[test]
129 fn unknown_media_and_lifecycle_values_fail_closed() {
130 let media: ActionMediaType =
131 serde_json::from_str("\"websocket\"").expect("未知请求媒体类型应安全解析");
132 let lifecycle: UploadLifecycle =
133 serde_json::from_str("\"permanent\"").expect("未知上传生命周期应安全解析");
134
135 assert_eq!(media, ActionMediaType::Json);
136 assert_eq!(lifecycle, UploadLifecycle::RequestScoped);
137 }
138
139 #[test]
140 fn multipart_defaults_are_bounded() {
141 let spec = MultipartSpec::new(["application/pdf"]);
142 assert_eq!(spec.max_fields, DEFAULT_MULTIPART_MAX_FIELDS);
143 assert_eq!(spec.max_files, DEFAULT_MULTIPART_MAX_FILES);
144 assert_eq!(spec.max_file_bytes, DEFAULT_MULTIPART_MAX_FILE_BYTES);
145 assert_eq!(
146 spec.max_text_field_bytes,
147 DEFAULT_MULTIPART_MAX_TEXT_FIELD_BYTES
148 );
149 assert_eq!(spec.max_total_bytes, DEFAULT_MULTIPART_MAX_TOTAL_BYTES);
150 assert_eq!(spec.lifecycle, UploadLifecycle::RequestScoped);
151 }
152}