Struct vector_config::schema::visitors::InlineSingleUseReferencesVisitor

pub struct InlineSingleUseReferencesVisitor { /* private fields */ }

A visitor that inlines schema references where the referenced schema is only referenced once.

In many cases, the schema generation will produce schema definitions where either generics or flattening are involved, which leads to schema definitions that may only be referenced by one other schema definition, and so on.

This is suboptimal due to the “pointer chasing” involved to resolve those schema references, when there’s no reason to inherently have a schema be defined such that it can be referenced.

This visitor collects a list of all schema references, and for any schemas which are referenced only once, will replace those references by inlining the referenced schema directly, and deleting the schema definition from the root definitions.

Implementations

impl InlineSingleUseReferencesVisitor

pub fn from_settings(_: &SchemaSettings) -> Self

Trait Implementations

impl Debug for InlineSingleUseReferencesVisitor

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

Formats the value using the given formatter.

impl Default for InlineSingleUseReferencesVisitor

fn default() -> InlineSingleUseReferencesVisitor

Returns the “default value” for a type.

impl Visitor for InlineSingleUseReferencesVisitor

fn visit_root_schema(&mut self, root: &mut RootSchema)

Override this method to modify a RootSchema and (optionally) its subschemas.

fn visit_schema_object( &mut self, definitions: &mut Map<String, Schema>, schema: &mut SchemaObject, )

Override this method to modify a SchemaObject and (optionally) its subschemas.

fn visit_schema( &mut self, definitions: &mut BTreeMap<String, Schema>, schema: &mut Schema, )

Override this method to modify a Schema and (optionally) its subschemas.