Struct vector_config::schema::visitors::GenerateHumanFriendlyNameVisitor

pub struct GenerateHumanFriendlyNameVisitor;

A visitor that generates a human-friendly name for enum variants and fields as metadata.

Generally, we rely on rich documentation to provide human-friendly descriptions of types and fields, but there is no such mechanism to provide a human-friendly name for types and fields directly from their documentation comments. While it is possible to do so with manual metadata annotations, it is laborious and prone to error.

This visitor generates a human-friendly name for types and fields, stored in metadata (docs::human_name) using a simple set of heuristics to figure out how to break apart type/field names, as well as what the case of each word should be, including accommodations for well-known technical terms/acronyms, and so on.

Opting out of the visitor behavior

This approach has a very high hit rate, as the corpus we’re operating on is generally small and well contained, leading to requiring only a small set of replacements and logic. However, for cases when this approach is not suitable, upstream usages can declare docs::human_name themselves. Whenever the visitor sees that the metadata annotation is already present, it will skip generating it.

Implementations

impl GenerateHumanFriendlyNameVisitor

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

Trait Implementations

impl Debug for GenerateHumanFriendlyNameVisitor

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

Formats the value using the given formatter.

impl Default for GenerateHumanFriendlyNameVisitor

fn default() -> GenerateHumanFriendlyNameVisitor

Returns the “default value” for a type.

impl Visitor for GenerateHumanFriendlyNameVisitor

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_root_schema(&mut self, root: &mut RootSchema)

Override this method to modify a RootSchema 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.