Struct ClientMetadata 

pub struct ClientMetadata {
    pub catalog: TreeNode,
    pub structural_patterns: Vec<StructuralPattern>,
    pub index_set_patterns: Vec<IndexSetPattern>,
    /* private fields */
}

Metadata extracted from brk_query for client generation.

Fields

catalog: TreeNode

The catalog tree structure (with schemas in leaves)

structural_patterns: Vec<StructuralPattern>

Structural patterns - tree node shapes that repeat

index_set_patterns: Vec<IndexSetPattern>

Index set patterns - sets of indexes that appear together on series

Implementations

impl ClientMetadata

pub fn from_vecs(vecs: &Vecs<'_>) -> Self

Extract metadata from brk_query::Vecs.

pub fn from_catalog(catalog: TreeNode) -> Self

Extract metadata from a catalog TreeNode directly.

pub fn find_index_set_pattern( &self, indexes: &BTreeSet<Index>, ) -> Option<&IndexSetPattern>

Find an index set pattern that matches the given indexes.

pub fn find_pattern(&self, name: &str) -> Option<&StructuralPattern>

Find a pattern by name.

pub fn is_parameterizable(&self, name: &str) -> bool

Check if a pattern is fully parameterizable (recursively). Returns false if the pattern or any nested branch pattern has no mode.

pub fn find_pattern_by_fields( &self, fields: &[PatternField], ) -> Option<&StructuralPattern>

Find a pattern by its concrete fields.

pub fn get_type_param(&self, fields: &[PatternField]) -> Option<&String>

Get the type parameter for a generic pattern given its concrete fields.

pub fn pattern_lookup(&self) -> &BTreeMap<Vec<PatternField>, String>

Get the pre-computed pattern lookup map.

pub fn get_node_base(&self, path: &str) -> Option<&PatternBaseResult>

Get the pre-computed PatternBaseResult for a tree path.

pub fn field_type_annotation( &self, field: &PatternField, is_generic: bool, generic_value_type: Option<&str>, syntax: GenericSyntax, ) -> String

Generate type annotation for a field with language-specific syntax.

pub fn field_type_annotation_from_leaf( &self, leaf: &SeriesLeafWithSchema, syntax: GenericSyntax, ) -> String

Generate type annotation for a leaf node with language-specific syntax.

This is a simpler version of field_type_annotation that works directly with a SeriesLeafWithSchema node instead of a PatternField.

Trait Implementations

impl Debug for ClientMetadata

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

Formats the value using the given formatter.