api-reference

API Reference

Complete API documentation for Rust Rule Engine.

---

📚 Available Documentation

API Reference

Complete public API reference.

Coverage:

• Engine API
• Facts API
• Rules API
• Knowledge Base API
• All public types and methods

Use when: Looking up specific API methods

GRL Query Syntax

Complete reference for backward chaining query language.

Coverage:

• Query syntax
• Nested queries (v1.11.0+)
• Query optimization (v1.11.0+)
• Aggregation functions
• Negation and disjunction
• Action handlers
• All query features

Use when: Writing backward chaining queries

Parser Cheat Sheet

Quick reference for GRL parser.

Coverage:

• Common syntax patterns
• Parser rules
• Quick examples
• Troubleshooting

Use when: Need quick syntax lookup

---

🎯 Find What You Need

By Feature

Forward Chaining → API Reference - Engine, Facts, Rules

Backward Chaining → GRL Query Syntax - Queries, Goals, Proofs

Parsing → Parser Cheat Sheet - GRL syntax

By Task

Creating an Engine

use rust_rule_engine::Engine;
let engine = Engine::new();

→ API Reference - Engine

Adding Rules

engine.add_rule_from_string(grl_string)?;

→ API Reference - Rules

Writing Queries

query "MyQuery" {
    goal: pattern WHERE subquery
    enable-optimization: true
}

→ GRL Query Syntax

Parsing GRL → Parser Cheat Sheet

---

📖 Version History

Version	Features	Documentation
1.11.0	Nested queries, Query optimization	GRL Query Syntax
1.10.0	Disjunction (OR)	GRL Query Syntax
1.9.0	Explanation system	GRL Query Syntax
1.8.0	Negation (NOT)	GRL Query Syntax
1.7.0	Aggregation functions	GRL Query Syntax

---

🔗 Related Documentation

• Getting Started - Quick start guide
• Core Features - GRL syntax and features
• Guides - How-to guides and best practices

---

📞 Need Help?

• Can't find an API? → Check API Reference
• Query not working? → See GRL Query Syntax
• Parser error? → Use Parser Cheat Sheet
• Still stuck? → Troubleshooting Guide

---

Navigation

📚 Documentation Home | 📖 Getting Started