#[non_exhaustive]pub struct Example {
pub summary: String,
pub description: String,
pub value: Option<Value>,
pub external_value: String,
}
Expand description
Implements OpenAPI Example Object.
Example is used on path operations to describe possible response bodies.
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.summary: String
Short description for the Example
.
description: String
Long description for the Example
. Value supports markdown syntax for rich text
representation.
value: Option<Value>
Embedded literal example value. Example::value
and Example::external_value
are
mutually exclusive.
external_value: String
An URI that points to a literal example value. Example::external_value
provides the
capability to references an example that cannot be easily included in JSON or YAML.
Example::value
and Example::external_value
are mutually exclusive.
Implementations§
Trait Implementations§
source§impl<'de> Deserialize<'de> for Example
impl<'de> Deserialize<'de> for Example
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 From<Example> for ExampleBuilder
impl From<Example> for ExampleBuilder
source§impl From<ExampleBuilder> for Example
impl From<ExampleBuilder> for Example
source§fn from(value: ExampleBuilder) -> Self
fn from(value: ExampleBuilder) -> Self
Converts to this type from the input type.
source§impl PartialEq for Example
impl PartialEq for Example
impl Eq for Example
impl StructuralPartialEq for Example
Auto Trait Implementations§
impl Freeze for Example
impl RefUnwindSafe for Example
impl Send for Example
impl Sync for Example
impl Unpin for Example
impl UnwindSafe for Example
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
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.