Struct Schema

pub struct Schema {
    pub data: SchemaData,
    pub kind: SchemaKind,
}

Fields

data: SchemaData

kind: SchemaKind

Implementations

impl Schema

pub fn new_number() -> Self

pub fn new_integer() -> Self

pub fn new_bool() -> Self

pub fn new_str_enum(enumeration: Vec<String>) -> Self

pub fn new_string() -> Self

pub fn new_object() -> Self

Create a schemaless object schema

pub fn new_map(inner: impl Into<RefOr<Schema>>) -> Self

Create a Map<String, inner> schema

pub fn new_map_any() -> Self

Create a Map<String, Any> schema

pub fn new_array_any() -> Self

Create an Array schema

pub fn new_array(inner: impl Into<RefOr<Schema>>) -> Self

Create a new array schema with items of the given type

pub fn new_one_of(one_of: Vec<RefOr<Schema>>) -> Self

pub fn new_all_of(all_of: Vec<RefOr<Schema>>) -> Self

pub fn new_any_of(any_of: Vec<RefOr<Schema>>) -> Self

pub fn new_any() -> Self

Create an Any schema

pub fn with_format(self, format: &str) -> Self

pub fn is_empty(&self) -> bool

impl Schema

pub fn properties(&self) -> &RefOrMap<Schema>

pub fn get_properties(&self) -> Option<&RefOrMap<Schema>>

pub fn get_properties_mut(&mut self) -> Option<&mut RefOrMap<Schema>>

pub fn properties_mut(&mut self) -> &mut RefOrMap<Schema>

pub fn properties_iter<'a>( &'a self, spec: &'a OpenAPI, ) -> Box<dyn Iterator<Item = (&'a String, &'a RefOr<Schema>)> + 'a>

pub fn is_required(&self, field: &str) -> bool

pub fn get_required(&self) -> Option<&Vec<String>>

pub fn required(&self) -> &Vec<String>

pub fn get_required_mut(&mut self) -> Option<&mut Vec<String>>

pub fn required_mut(&mut self) -> &mut Vec<String>

pub fn add_required(&mut self, field: &str)

pub fn remove_required(&mut self, field: &str)

pub fn is_anonymous_object(&self) -> bool

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Deref for Schema

type Target = SchemaData

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Schema

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Into<Schema> for Schema

Available on crate feature v2 only.

fn into(self) -> Schema

Converts this type into the (usually inferred) input type.

impl PartialEq for Schema

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Schema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Schema