Struct SchemaRegistry 

pub struct SchemaRegistry { /* private fields */ }

Collects named schema definitions while schemas are generated.

Implementations

impl SchemaRegistry

pub fn new() -> Self

Empty registry.

pub fn subschema<T: Schema + ?Sized + 'static>(&mut self) -> SchemaObject

Schema to embed for T: a $ref if T is named, otherwise inline.

pub fn add_security_scheme(&mut self, name: &str, scheme: Value)

Register an OpenAPI security scheme under name (components.securitySchemes).

Registering the same definition twice is a no-op; a different definition under an existing name is recorded as a SchemaConflict.

pub fn take_security_schemes(&mut self) -> BTreeMap<String, Value>

Remove and return every registered security scheme.

pub fn into_components( self, ) -> Result<BTreeMap<String, SchemaObject>, Vec<SchemaConflict>>

Consume the registry, returning components.schemas.

Errors

Returns every SchemaConflict detected during generation.

Trait Implementations

impl Clone for SchemaRegistry

fn clone(&self) -> SchemaRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaRegistry

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

Formats the value using the given formatter.

impl Default for SchemaRegistry

fn default() -> SchemaRegistry

Returns the “default value” for a type.