Module prelude 

This module makes it easier to use egglog from Rust.

use egglog::prelude::*;

Common entry points:

• rule / rust_rule — add rules whose RHS is egglog code or a Rust closure (the closure receives an crate::WriteState).
• query — run a one-shot query and read out matches.
• BaseSort / ContainerSort — declare custom sort types.
• crate::PurePrim / crate::WritePrim / crate::ReadPrim / crate::FullPrim — register custom primitives via the matching EGraph::add_*_primitive method.
• The add_primitive! / add_primitive_with_validator! / add_literal_prim! macros (re-exported via egglog::*) cover the simple “pure native function” case.

Re-exports

pub use egglog::ast::Action;

pub use egglog::ast::Fact;

pub use egglog::ast::Facts;

pub use egglog::sort::BigIntSort;

pub use egglog::sort::BigRatSort;

pub use egglog::sort::BoolSort;

pub use egglog::sort::F64Sort;

pub use egglog::sort::I64Sort;

pub use egglog::sort::StringSort;

pub use egglog::sort::UnitSort;

pub use egglog::CommandMacro;

pub use egglog::CommandMacroRegistry;

pub use egglog::Core;

pub use egglog::FullState;

pub use egglog::PureState;

pub use egglog::Read;

pub use egglog::ReadState;

pub use egglog::Write;

pub use egglog::WriteState;

pub use egglog::EGraph;

pub use egglog::sort;

pub use egglog::sort;

Modules

exprs

Macros

action

actions

datatype

Adds sorts and constructor tables to the database.

expr

fact

facts

sort

span

vars

Structs

GenericActions

QueryResult

The result of a query.

RustSpan

Enums

Span

Traits

BaseSort

A “default” implementation of Sort for simple types which just want to put some data in the e-graph. If you implement this trait, do not implement Sort or ContainerSort. Use add_base_sortto register base sorts with theEGraph. See Sortfor documentation of the methods. Do not overrideto_arcsort`.

ContainerSort

A “default” implementation of Sort for types which just want to store a pure data structure in the e-graph. If you implement this trait, do not implement Sort or BaseSort. Use add_container_sort to register container sorts with the EGraph. See Sort for documentation of the methods. Do not override to_arcsort.

LiteralConvertible

Trait for types that can be converted to/from Literal for use in validated primitives. This enables automatic validator generation for literal primitives.

Functions

add_base_sort

Add a BaseSort to the e-graph

add_constructor

Declare a new constructor table.

add_container_sort

add_function

Declare a new function table.

add_relation

Declare a new relation table.

add_ruleset

Create a new ruleset.

add_sort

Declare a new sort.

query

Run a query over the database.

rule

Add a rule to the e-graph whose right-hand side is made up of actions.

run_ruleset

Run one iteration of a ruleset.

rust_rule

Add a rule to the e-graph whose right-hand side is a Rust callback.

rust_rule_full

Like rust_rule, but the action callback receives a FullState — it can read tables (ctx.lookup) in addition to writing them. Action callbacks of FullPrim are only valid in Context::Full, so this helper marks the generated rule :naive: the body matches against the entire database every iteration instead of using the seminaive delta. Use this when the action genuinely needs to look up rows; prefer rust_rule when the data can be bound via the matcher in the rule body.