Struct vector_config_common::schema::SchemaGenerator

pub struct SchemaGenerator { /* private fields */ }

Schema generator.

This is the main entrypoint for storing the defined schemas within a given root schema, and referencing existing schema definitions.

Implementations

impl SchemaGenerator

pub fn new(settings: SchemaSettings) -> SchemaGenerator

Creates a new SchemaGenerator using the given settings.

pub fn settings(&self) -> &SchemaSettings

Gets the SchemaSettings being used by this SchemaGenerator.

pub fn definitions(&self) -> &Map<String, Schema>

Borrows the collection of all referenceable schemas that have been generated.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

pub fn definitions_mut(&mut self) -> &mut Map<String, Schema>

Mutably borrows the collection of all referenceable schemas that have been generated.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

pub fn dereference<'a>(&'a self, schema: &Schema) -> Option<&'a Schema>

Attempts to find the schema that the given schema is referencing.

If the given schema has a $ref property which refers to another schema in self’s schema definitions, the referenced schema will be returned. Otherwise, returns None.

pub fn into_root_schema(self, root_schema: SchemaObject) -> RootSchema

Converts this generator into a root schema, using the given root_schema as the top-level definition.

This assumes the root schema was generated using this generator, such that any schema definitions referenced by root_schema refer to this generator.

All other relevant settings (i.e. meta-schema) are carried over.

Trait Implementations

impl Debug for SchemaGenerator

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

Formats the value using the given formatter.

impl Default for SchemaGenerator

fn default() -> SchemaGenerator

Returns the “default value” for a type.

impl From<SchemaSettings> for SchemaGenerator

fn from(settings: SchemaSettings) -> Self

Converts to this type from the input type.