1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
//! Implements encoding object for content.
use indexmap::IndexMap;
use super::Header;
use super::extensions::Extensions;
use super::path::ParameterStyle;
/// A single encoding definition applied to a single schema [`Object
/// property`](crate::schema::Object::properties).
#[derive(serde_derive::Serialize, serde_derive::Deserialize, Default, Clone, PartialEq, bon::Builder)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct Encoding {
/// The Content-Type for encoding a specific property. Default value depends on the property
/// type: for string with format being binary – `application/octet-stream`; for other primitive
/// types – `text/plain`; for object - `application/json`; for array – the default is defined
/// based on the inner type. The value can be a specific media type (e.g. `application/json`),
/// a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types.
#[serde(skip_serializing_if = "Option::is_none", default)]
pub content_type: Option<String>,
/// A map allowing additional information to be provided as headers, for example
/// Content-Disposition. Content-Type is described separately and SHALL be ignored in this
/// section. This property SHALL be ignored if the request body media type is not a multipart.
#[serde(skip_serializing_if = "IndexMap::is_empty", default)]
#[builder(default)]
pub headers: IndexMap<String, Header>,
/// Describes how a specific property value will be serialized depending on its type. See
/// Parameter Object for details on the style property. The behavior follows the same values as
/// query parameters, including default values. This property SHALL be ignored if the request
/// body media type is not `application/x-www-form-urlencoded`.
#[serde(skip_serializing_if = "Option::is_none", default)]
pub style: Option<ParameterStyle>,
/// When this is true, property values of type array or object generate separate parameters for
/// each value of the array, or key-value-pair of the map. For other types of properties this
/// property has no effect. When style is form, the default value is true. For all other
/// styles, the default value is false. This property SHALL be ignored if the request body
/// media type is not `application/x-www-form-urlencoded`.
#[serde(skip_serializing_if = "Option::is_none", default)]
pub explode: Option<bool>,
/// Determines whether the parameter value SHOULD allow reserved characters, as defined by
/// RFC3986 `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is
/// false. This property SHALL be ignored if the request body media type is not
/// `application/x-www-form-urlencoded`.
#[serde(skip_serializing_if = "Option::is_none", default)]
pub allow_reserved: Option<bool>,
/// Optional extensions "x-something".
#[serde(skip_serializing_if = "Option::is_none", default, flatten)]
pub extensions: Option<Extensions>,
}
impl<S: encoding_builder::IsComplete> From<EncodingBuilder<S>> for Encoding {
fn from(builder: EncodingBuilder<S>) -> Self {
builder.build()
}
}