Enum Schema 

pub enum Schema {
    Bool(bool),
    Object(Box<SchemaObject>),
}

A JSON Schema.

A boolean is a valid schema in JSON Schema 2020-12: true accepts every instance and false accepts none. That is why this is an enum rather than a struct.

Schema::Bool(true) is how a genuinely unconstrained payload is represented. Kynos never produces it by accident — a Rust type that cannot describe itself has no Schema implementation at all, and the permissive schema is reachable only by naming it in the handler signature.

Variants

Bool(bool)

The trivially true (true) or trivially false (false) schema.

Object(Box<SchemaObject>)

A schema with keywords.

Implementations

impl Schema

pub fn any() -> Self

The schema that accepts any instance.

pub fn never() -> Self

The schema that accepts no instance.

pub fn of_type(ty: SchemaType) -> Self

A schema constrained to a single primitive type.

pub fn nullable(ty: SchemaType) -> Self

A schema that is ty or null.

This is how nullability is expressed from OpenAPI 3.1 onward. The 3.0 nullable: true keyword does not exist and must never be emitted.

pub fn reference(uri: impl Into<String>) -> Self

A $ref to another schema.

Unlike a Ref, sibling keywords on a schema $ref are applied rather than ignored.

pub fn component(name: &str) -> Self

A $ref to a named entry under #/components/schemas.

pub fn as_object(&self) -> Option<&SchemaObject>

Returns the keyword-carrying form, if this is not a boolean schema.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Self

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 Default for Schema

fn default() -> Self

Returns the “default value” for a type.

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 PartialEq for Schema

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

Equality operator ==.

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

Inequality operator !=.

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