Skip to main content

OpenApiSchema

Struct OpenApiSchema 

Source
pub struct OpenApiSchema(/* private fields */);
Expand description

OpenAPI schema value. This intentionally stays schema-crate neutral.

Implementations§

Source§

impl OpenApiSchema

Source

pub fn from_value(value: Value) -> Self

Source

pub fn string() -> Self

Source

pub fn integer() -> Self

Source

pub fn number() -> Self

Source

pub fn boolean() -> Self

Source

pub fn object() -> Self

Source

pub fn array(items: OpenApiSchema) -> Self

Source

pub fn string_enum<I, S>(values: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn binary_file() -> Self

Source

pub fn all_of<I>(schemas: I) -> Self
where I: IntoIterator<Item = OpenApiSchema>,

Source

pub fn one_of<I>(schemas: I) -> Self
where I: IntoIterator<Item = OpenApiSchema>,

Source

pub fn any_of<I>(schemas: I) -> Self
where I: IntoIterator<Item = OpenApiSchema>,

Source

pub fn object_with_properties<P, K, R, S>(properties: P, required: R) -> Self
where P: IntoIterator<Item = (K, OpenApiSchema)>, K: Into<String>, R: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn with_title(self, title: impl Into<String>) -> Self

Source

pub fn with_description(self, description: impl Into<String>) -> Self

Source

pub fn with_format(self, format: impl Into<String>) -> Self

Source

pub fn nullable(self) -> Self

Source

pub fn with_property( self, name: impl Into<String>, schema: OpenApiSchema, ) -> Self

Source

pub fn with_required(self, name: impl Into<String>) -> Self

Source

pub fn with_additional_properties(self, schema: OpenApiSchema) -> Self

Source

pub fn with_discriminator(self, property_name: impl Into<String>) -> Self

Source

pub fn with_discriminator_mapping<I, K, V>( self, property_name: impl Into<String>, mapping: I, ) -> Self
where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Source

pub fn with_extension_value(self, name: impl Into<String>, value: Value) -> Self

Source

pub fn try_with_extension<T>( self, name: impl Into<String>, value: T, ) -> Result<Self>
where T: Serialize,

Source

pub fn partial(self) -> Self

Source

pub fn pick_properties<I, S>(self, names: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn omit_properties<I, S>(self, names: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn reference(name: impl AsRef<str>) -> Self

Source

pub fn into_value(self) -> Value

Trait Implementations§

Source§

impl Clone for OpenApiSchema

Source§

fn clone(&self) -> OpenApiSchema

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 OpenApiSchema

Source§

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

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

impl PartialEq for OpenApiSchema

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for OpenApiSchema

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 OpenApiSchema

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more