#[non_exhaustive]pub struct Header {
pub schema: RefOr<Schema>,
pub description: Option<String>,
}
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: RefOr<Schema>
Schema of header type.
description: Option<String>
Additional description of the header value.
Implementations§
source§impl Header
impl Header
sourcepub fn new<C: Into<RefOr<Schema>>>(component: C) -> Self
pub fn new<C: Into<RefOr<Schema>>>(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(Object::with_type(SchemaType::Integer));
Create a new Header
with default type String
let header = Header::default();
Trait Implementations§
source§impl<'de> Deserialize<'de> for Header
impl<'de> Deserialize<'de> for Header
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<Header> for HeaderBuilder
impl From<Header> for HeaderBuilder
source§impl From<HeaderBuilder> for Header
impl From<HeaderBuilder> for Header
source§fn from(value: HeaderBuilder) -> Self
fn from(value: HeaderBuilder) -> Self
Converts to this type from the input type.
source§impl PartialEq for Header
impl PartialEq for Header
impl StructuralPartialEq for Header
Auto Trait Implementations§
impl Freeze for Header
impl RefUnwindSafe for Header
impl Send for Header
impl Sync for Header
impl Unpin for Header
impl UnwindSafe for Header
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
)