Skip to main content

NamedType

Struct NamedType 

Source
pub struct NamedType {
Show 13 fields pub id: String, pub original_name: Option<String>, pub documentation: Option<String>, pub title: Option<String>, pub read_only: bool, pub write_only: bool, pub external_docs: Option<ExternalDocs>, pub default: Option<ValueRef>, pub examples: Vec<(String, Example)>, pub xml: Option<XmlObject>, pub definition: TypeDef, pub extensions: Vec<(String, ValueRef)>, pub location: Option<SpecLocation>,
}

Fields§

§id: String§original_name: Option<String>§documentation: Option<String>

Long-form schema description (description in JSON Schema).

§title: Option<String>

Short human label (title in JSON Schema). Doc generators and IDE hover surface it; populated verbatim, never derived.

§read_only: bool

JSON Schema readOnly at the schema level. Generators that distinguish request from response shapes can opt to drop read_only types from their request surface.

§write_only: bool

JSON Schema writeOnly at the schema level. Generators that distinguish request from response shapes can opt to drop write_only types from their response surface.

§external_docs: Option<ExternalDocs>

Per-schema externalDocs (OAS Schema Object).

§default: Option<ValueRef>

JSON Schema default at the schema level. ValueRef indexes into crate::Ir::values; compound defaults are pooled there.

§examples: Vec<(String, Example)>

OAS example / examples on the schema. Named entries; 3.0 example: <literal> lands under the synthetic key "_default".

§xml: Option<XmlObject>

OAS xml block — name override, namespace, prefix, attribute placement, array wrapping. None unless the spec declared one.

§definition: TypeDef§extensions: Vec<(String, ValueRef)>

x-* extensions declared on the schema. Each entry pairs a key with a ValueRef into crate::Ir::values; compound values are pooled there.

§location: Option<SpecLocation>

Trait Implementations§

Source§

impl Clone for NamedType

Source§

fn clone(&self) -> NamedType

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 NamedType

Source§

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

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

impl<'de> Deserialize<'de> for NamedType

Source§

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 NamedType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for NamedType

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for NamedType

Auto Trait Implementations§

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,