Struct LocyEngine 

pub struct LocyEngine<'a> { /* private fields */ }

Engine for evaluating Locy programs against a real database.

Implementations

impl<'a> LocyEngine<'a>

pub fn compile_only(&self, program: &str) -> Result<CompiledProgram>

Parse and compile a Locy program without executing it.

If the session’s rule registry contains pre-compiled rules, their names are passed to the compiler so that IS-ref and QUERY references to registered rules are accepted during validation.

pub fn register(&self, program: &str) -> Result<()>

Compile and register a Locy program’s rules for reuse.

Rules registered here persist within the database session and are automatically merged into subsequent evaluate() calls, so notebooks can define rules once and run QUERY, EXPLAIN, ASSUME, ABDUCE without redeclaring the full rule set each time.

pub fn clear_registry(&self)

Clear all registered Locy rules from the session.

pub async fn evaluate(&self, program: &str) -> Result<LocyResult>

Parse, compile, and evaluate a Locy program with default config.

pub fn evaluate_with(&self, program: &str) -> InnerLocyBuilder<'_>

Start building a Locy evaluation with fluent parameter binding.

Mirrors db.query_with(cypher).param(…).fetch_all() for Cypher.

Examples

let result = db.session()
    .locy_with("CREATE RULE ep AS MATCH (e:Episode) WHERE e.agent_id = $aid YIELD KEY e")
    .param("aid", "agent-123")
    .run()
    .await?;

pub async fn explain(&self, program: &str) -> Result<LocyResult>

Convenience wrapper for EXPLAIN RULE commands.

pub async fn evaluate_with_config( &self, program: &str, config: &LocyConfig, ) -> Result<LocyResult>

Parse, compile, and evaluate a Locy program with custom config.

If rules were previously registered via register(), they are automatically merged into the compiled program before execution.

pub async fn evaluate_compiled_with_config( &self, compiled: CompiledProgram, config: &LocyConfig, ) -> Result<LocyResult>

Evaluate an already-compiled Locy program with custom config.

This is the core execution path: it takes a CompiledProgram (with any registry merges already applied) and runs it through planning, execution, and command dispatch.