Struct FieldRegistry 

pub struct FieldRegistry { /* private fields */ }

Registry of all queryable fields (core + plugin fields)

The field registry maintains a mapping of field names to their descriptors, which include type information, supported operators, indexing status, and documentation.

Example

use sqry_core::query::registry::FieldRegistry;

let registry = FieldRegistry::with_core_fields();
assert!(registry.get("kind").is_some());
assert!(registry.get("name").is_some());

Implementations

impl FieldRegistry

pub fn new() -> Self

Create an empty field registry

pub fn with_core_fields() -> Self

Create a field registry with core fields pre-populated

Core fields are always available and include:

• kind: Node type (function, method, class, etc.)
• name: Node name (exact or regex match)
• path: File path (glob or regex match) - aliased as file
• lang: Programming language - aliased as language
• repo: Repository filter (glob pattern)
• parent: Parent symbol name (regex match)
• scope: Scope type (file, module, class, function, block)
• text: Full-text search in symbol body (NOT indexed)

pub fn add_field(&mut self, descriptor: FieldDescriptor)

Add a field descriptor to the registry

If a field with the same name already exists, it will be replaced.

pub fn add_alias( &mut self, alias: impl Into<String>, canonical: impl Into<String>, )

Register an alias for a field

Aliases allow alternative names for fields (e.g., “file” as alias for “path”). The canonical field must already exist in the registry.

Arguments

• alias - The alias name (e.g., “file”)
• canonical - The canonical field name (e.g., “path”)

Panics

Panics if the canonical field does not exist in the registry.

pub fn get(&self, name: &str) -> Option<&FieldDescriptor>

Get a field descriptor by name or alias

If the name is an alias, this resolves to the canonical field.

pub fn resolve_canonical<'a>(&'a self, name: &'a str) -> Option<&'a str>

Resolve a field name to its canonical form

If the name is an alias, returns the canonical name. Otherwise, returns the name unchanged if it exists in the registry.

Returns None if the field name (or alias) doesn’t exist.

pub fn field_names(&self) -> Vec<&str>

Get all field names

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

Check if a field or alias exists

pub fn len(&self) -> usize

Get the number of fields in the registry

pub fn is_empty(&self) -> bool

Check if the registry is empty

pub fn add_plugin_fields(&mut self, fields: &[FieldDescriptor]) -> Vec<String>

Add plugin fields to the registry (Phase 7+)

Merges plugin-specific fields with existing fields. If a field name collides with an existing field, the plugin field will NOT be added.

Arguments

• fields - Slice of field descriptors from a plugin

Returns

Vector of field names that collided (were NOT added)

Example

let mut registry = FieldRegistry::with_core_fields();
let rust_plugin = RustPlugin::new();
let collisions = registry.add_plugin_fields(rust_plugin.fields());
assert!(collisions.is_empty()); // No collisions with core fields

pub fn plugin_ids(&self) -> Vec<String>

Get plugin IDs for cache key generation (Phase 7+)

Returns a sorted list of unique plugin identifiers based on registered fields. This is used to create cache keys that are sensitive to which plugins are loaded.

Note: Since we don’t track which field came from which plugin, this method currently returns an empty vector. In the future, we could add plugin metadata to FieldDescriptor to enable this functionality.

Trait Implementations

impl Clone for FieldRegistry

fn clone(&self) -> FieldRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldRegistry

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

Formats the value using the given formatter.

impl Default for FieldRegistry

fn default() -> Self

Returns the “default value” for a type.