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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
#[serde(untagged)]
#[derive(schemars::JsonSchema)]
pub enum ReferenceOr<T> {
Reference {
/// REQUIRED. The reference identifier. This MUST be in the form of a
/// URI.
#[serde(rename = "$ref")]
reference: String,
/// A short summary which by default SHOULD override that of the
/// referenced component. If the referenced object-type does not allow a
/// `summary` field, then this field has no effect.
#[serde(skip_serializing_if = "Option::is_none")]
summary: Option<String>,
/// A description which by default SHOULD override that of the
/// referenced component. CommonMark syntax MAY be used for rich text
/// representation. If the referenced object-type does not allow a
/// `description` field, then this field has no effect.
#[serde(skip_serializing_if = "Option::is_none")]
description: Option<String>,
},
Item(T),
}
impl<T> ReferenceOr<T> {
pub fn ref_(r: &str) -> Self {
ReferenceOr::Reference {
reference: r.to_owned(),
summary: None,
description: None,
}
}
pub fn boxed_item(item: T) -> ReferenceOr<Box<T>> {
ReferenceOr::Item(Box::new(item))
}
/// Converts this [ReferenceOr] to the item inside, if it exists.
///
/// The return value will be [Option::Some] if this was a
/// [ReferenceOr::Item] or [Option::None] if this was a
/// [ReferenceOr::Reference].
///
/// # Examples
///
/// ```
/// # use aide::openapi::ReferenceOr;
///
/// let i = ReferenceOr::Item(1);
/// assert_eq!(i.into_item(), Some(1));
///
/// let j: ReferenceOr<u8> = ReferenceOr::Reference { reference: String::new(), summary: None, description: None };
/// assert_eq!(j.into_item(), None);
/// ```
pub fn into_item(self) -> Option<T> {
match self {
ReferenceOr::Reference { .. } => None,
ReferenceOr::Item(i) => Some(i),
}
}
/// Returns a reference to to the item inside this [ReferenceOr], if it
/// exists.
///
/// The return value will be [Option::Some] if this was a
/// [ReferenceOr::Item] or [Option::None] if this was a
/// [ReferenceOr::Reference].
///
/// # Examples
///
/// ```
/// # use aide::openapi::ReferenceOr;
///
/// let i = ReferenceOr::Item(1);
/// assert_eq!(i.as_item(), Some(&1));
///
/// let j: ReferenceOr<u8> = ReferenceOr::Reference { reference: String::new(), summary: None, description: None };
/// assert_eq!(j.as_item(), None);
/// ```
pub fn as_item(&self) -> Option<&T> {
match self {
ReferenceOr::Reference { .. } => None,
ReferenceOr::Item(i) => Some(i),
}
}
/// Mutable version of [`as_item`](ReferenceOr::as_item).
pub fn as_item_mut(&mut self) -> Option<&mut T> {
match self {
ReferenceOr::Reference { .. } => None,
ReferenceOr::Item(i) => Some(i),
}
}
}
impl<T> ReferenceOr<Box<T>> {
pub fn unbox(self) -> ReferenceOr<T> {
match self {
ReferenceOr::Reference {
reference,
summary,
description,
} => ReferenceOr::Reference {
reference,
summary,
description,
},
ReferenceOr::Item(boxed) => ReferenceOr::Item(*boxed),
}
}
}