Expand description
Implements OpenAPI Header Object for response headers.
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.schema: Component
Schema of header type.
description: Option<String>
Additional descripiton of the header value.
Implementations
sourceimpl Header
impl Header
sourcepub fn new<C: Into<Component>>(component: C) -> Self
pub fn new<C: Into<Component>>(component: C) -> Self
Construct a new Header
with custom schema. If you wish to construct a default
header with String
type you can use Header::default
function.
Examples
Create new Header
with integer type.
let header = Header::new(Property::new(ComponentType::Integer));
Create a new Header
with default type String
let header = Header::default();
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Header
impl<'de> Deserialize<'de> for Header
sourcefn 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
sourceimpl From<Header> for HeaderBuilder
impl From<Header> for HeaderBuilder
sourceimpl From<HeaderBuilder> for Header
impl From<HeaderBuilder> for Header
sourcefn from(value: HeaderBuilder) -> Self
fn from(value: HeaderBuilder) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl RefUnwindSafe for Header
impl Send for Header
impl Sync for Header
impl Unpin for Header
impl UnwindSafe for Header
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more