Skip to main content

Field

Struct Field 

Source
pub struct Field {
    pub name: RustIdent,
    pub rename: Option<String>,
    pub doc: Option<String>,
    pub deprecated: Option<Deprecation>,
    pub ty: RustType,
    pub required: bool,
    pub omit_empty: Option<bool>,
    pub serde_skip: bool,
    pub default: Option<DefaultValue>,
    pub constraints: Option<Constraints>,
}
Expand description

A single struct field.

Fields§

§name: RustIdent

Rust field identifier.

§rename: Option<String>

#[serde(rename = "...")] value, when the wire name differs.

§doc: Option<String>

Doc comment derived from the property description.

§deprecated: Option<Deprecation>

#[deprecated] annotation from deprecated: true (+ x-deprecated-reason).

§ty: RustType

Field type (already wrapped in Option<..> when optional).

§required: bool

Whether the property is required. Optional fields get #[serde(skip_serializing_if = "Option::is_none")] unless Self::omit_empty overrides it.

§omit_empty: Option<bool>

x-omitempty override: Some(true)/Some(false) forces the skip_serializing_if on/off. None keeps the default (skip when optional).

§serde_skip: bool

x-rust-serde-skip: drop the field from (de)serialization via #[serde(skip)].

§default: Option<DefaultValue>

The value that serde uses when the property is absent, from default.

An optional property with a default is not wrapped in Option. Once parsed, it always holds a value. Only nullable keeps the Option, because there null is a value that the property can carry.

default: null never reaches here. The parser reads it as no default at all, and serde already leaves a missing Option as None.

§constraints: Option<Constraints>

The validation keywords the property declares, when it declares any.

The generator checks these on the way in, so the check runs only where the code deserializes. A response the server writes is not checked.

Trait Implementations§

Source§

impl Clone for Field

Source§

fn clone(&self) -> Field

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Field

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Field

Source§

fn eq(&self, other: &Field) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Field

Auto Trait Implementations§

§

impl Freeze for Field

§

impl RefUnwindSafe for Field

§

impl Send for Field

§

impl Sync for Field

§

impl Unpin for Field

§

impl UnsafeUnpin for Field

§

impl UnwindSafe for Field

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.