Struct salvo_oapi::Response
source · #[non_exhaustive]pub struct Response {
pub description: String,
pub headers: BTreeMap<String, Header>,
pub contents: IndexMap<String, Content>,
pub extensions: Option<HashMap<String, Value>>,
}
Expand description
Implements OpenAPI Response Object.
Response is api operation response.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.description: String
Description of the response. Response support markdown syntax.
headers: BTreeMap<String, Header>
Map of headers identified by their name. Content-Type
header will be ignored.
contents: IndexMap<String, Content>
Map of response Content
objects identified by response body content type e.g application/json
.
Content
s are stored within IndexMap
to retain their insertion order. Swagger UI
will create and show default example according to the first entry in content
map.
extensions: Option<HashMap<String, Value>>
Optional extensions “x-something”
Implementations§
source§impl Response
impl Response
sourcepub fn new<S: Into<String>>(description: S) -> Self
pub fn new<S: Into<String>>(description: S) -> Self
Construct a new Response
.
Function takes description as argument.
sourcepub fn description<I: Into<String>>(self, description: I) -> Self
pub fn description<I: Into<String>>(self, description: I) -> Self
Add description. Description supports markdown syntax.
Trait Implementations§
source§impl<'de> Deserialize<'de> for Response
impl<'de> Deserialize<'de> for Response
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl PartialEq for Response
impl PartialEq for Response
impl StructuralPartialEq for Response
Auto Trait Implementations§
impl Freeze for Response
impl RefUnwindSafe for Response
impl Send for Response
impl Sync for Response
impl Unpin for Response
impl UnwindSafe for Response
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more