Struct SchemaValue 

pub struct SchemaValue {

    pub kind: SchemaKind,
    pub nullable: bool,
    pub optional: bool,
    pub nullish: bool,
    pub format: Option<String>,
    pub enum_values: Vec<Value>,
    pub const_value: Option<Value>,
    pub default: Option<Value>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub deprecated: bool,
    pub read_only: bool,
    pub write_only: bool,
    pub discriminator: Option<Discriminator>,
    pub constraints: BTreeMap<String, Value>,
    pub extensions: BTreeMap<String, Value>,
}

A recursively composable API type. This is deliberately target neutral: plugins decide whether (for example) String { format: uuid } becomes a branded TypeScript string, a Python UUID, or a Rust uuid::Uuid.

Fields

kind: SchemaKind

nullable: bool

optional: bool

A target-neutral schema wrapper for contexts which retain optionality on the value rather than on an enclosing object property.

nullish: bool

A target-neutral schema wrapper for values which accept either null or undefined. OpenAPI itself normally models this through a nullable, non-required property, but retaining it makes lossless adapters and schema generators possible.

format: Option<String>

enum_values: Vec<Value>

const_value: Option<Value>

default: Option<Value>

title: Option<String>

description: Option<String>

deprecated: bool

read_only: bool

write_only: bool

discriminator: Option<Discriminator>

constraints: BTreeMap<String, Value>

Validation keywords and vendor-neutral OpenAPI keywords which do not alter the structural shape. Keeping them here means an adapter does not throw away constraints that a target plugin may support later.

extensions: BTreeMap<String, Value>

Unknown x-* and future schema keywords. This is a forward-compatible lossless escape hatch; core generators must not depend on it.

Implementations

impl SchemaValue

pub fn new(kind: SchemaKind) -> Self

pub fn unknown() -> Self

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

Trait Implementations

impl Clone for SchemaValue

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 SchemaValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaValue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SchemaValue

impl PartialEq for SchemaValue

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SchemaValue

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 SchemaValue