Struct CodeAdapter 

pub struct CodeAdapter { /* private fields */ }

A parsed source file, exposed as its syntax tree.

Implementations

impl CodeAdapter

pub fn parse(text: &str, ext: &str) -> Result<Self, CodeError>

Parse source text as ext’s language. When the thread’s AST cache is enabled (see set_cache), a cache hit for this exact content skips tree-sitter entirely; a miss parses and stores. Caching is transparent — the returned adapter is identical either way.

pub fn open(path: &Path) -> Result<Self, CodeError>

Parse a file, language by extension.

pub fn locator(&self, node: NodeId) -> String

A human-readable locator: /kind[start-line] chain.

Trait Implementations

impl AstAdapter for CodeAdapter

fn name(&self, node: NodeId) -> Option<String>

The node kind (function_item, identifier, …); the root (source_file/module/program) stays unnamed so / starts at its children.

fn traits(&self, node: NodeId) -> Vec<String>

The kind, as a trait too (<function_item> where a trait filter reads better than a name step).

fn property(&self, node: NodeId, name: &str) -> Option<Value>

Tree-sitter fields: ::name on a function is the name child’s source text.

fn default_value(&self, node: NodeId) -> Option<Value>

A node’s source text.

fn root(&self) -> NodeId

The root node — the initial navigation context.

fn children(&self, node: NodeId) -> Vec<NodeId>

The tree children of node, in document order.

fn parent(&self, node: NodeId) -> Option<NodeId>

The parent of node, or None for the root.

fn metadata(&self, node: NodeId, key: &str) -> Option<Value>

Adapter-defined metadata — ;;;key (a filesystem adapter’s size, modified, permissions, …). None if absent.

fn children_named(&self, node: NodeId, name: &str) -> Vec<NodeId>

The children of node whose edge name is exactly name — the engine’s fast path for name-matcher child hops. The default filters children; an adapter whose containers cannot be enumerated (permission-scoped or unbounded remote trees) overrides this with a direct, name-addressed lookup. Must be observationally identical to the default wherever enumeration works. The adapter owns the name test: it may deliberately alias — resolve a name to a node whose edge name differs (git revision syntax landing on a hash-named commit) — and the engine will not re-filter.

fn links(&self, _node: NodeId) -> Vec<(String, NodeId)>

Outgoing crosslinks from node, as (label, target) pairs, for -> navigation (a filesystem adapter’s symlinks).

fn backlinks(&self, _node: NodeId) -> Vec<(String, NodeId)>

Incoming crosslinks to node, as (label, source) pairs, for <- navigation. May be expensive (an adapter that does not precompute edges must search for referrers).

fn resolve( &self, _node: NodeId, _property: &str, _hint: Option<&str>, ) -> Option<NodeId>

Resolve a cross-reference: ::property~>hint maps node’s property (a value that references another node) to its target, with an optional adapter-specific relation hint. A JSON adapter resolves a $ref JSON Pointer; None if unresolvable.

fn link_property( &self, _source: NodeId, _label: &str, _target: NodeId, _name: &str, ) -> Option<Value>

A property of the crosslink source --label--> target — the $-::prop read. Adapters whose edges carry data (a property graph’s relationship properties) override this; None if the edge is bare or unknown. Where parallel edges share source, label, and target, the adapter answers for one of them, consistently.

fn quantifier_bound(&self) -> usize

The quantifier bound N_max: the depth to which open-ended path quantifiers (+, *, {m,}) expand, and the ceiling of any explicit {m,n} (the effective upper bound is min(n, N_max)). An adapter whose natural structures run deep may raise it; the CLI overrides it per run (qua --quantifier-bound).

fn allow_shell(&self) -> bool

Whether the sh(...) pipeline stage may run external commands. False by default — query text stays inert data — and enabled per run by the CLI (qua --allow-shell) through the AllowShell wrapper.

fn invocation_instant(&self) -> Option<(i64, u32)>

The invocation instant now() denotes (spec: The Temporal Fragment, Determinism): one UTC timeline point bound by the runner BEFORE evaluation begins — evaluation itself never reads a clock. None by default (a library run is fully deterministic; now() reads as null); the CLI binds it at startup — pinnable with qua --now — through the WithNow wrapper.

fn unit_scale(&self, expr: &str) -> Option<(f64, String)>

The scale of a unit expression — (factor, canonical SI-base expansion) — for the unital reading’s criterion text (spec: The Quantital Fragment). The default answers from the engine’s frozen built-in table; a unit-aware adapter (kaiv) overrides it to include the mounted document’s own custom units, so [::range < '50kellicam'] resolves through the document’s .!units imports.