RuleEngine

Struct RuleEngine 

Source
pub struct RuleEngine { /* private fields */ }
Expand description

Convenience wrapper around RustRuleEngine with JSON integration

This provides a simplified API for common use cases while maintaining full access to the underlying rust-rule-engine capabilities.

§Thread Safety

RustRuleEngine is thread-safe (Send + Sync), making it suitable for use in multi-threaded web services like Axum.

§Example

use rust_logic_graph::RuleEngine;
use std::collections::HashMap;
use serde_json::json;

let mut engine = RuleEngine::new();

let grl = r#"
    rule "discount_rule" {
        salience 100
        when
            total > 100
        then
            discount = total * 0.1;
    }
"#;

engine.add_grl_rule(grl).unwrap();

let mut context = HashMap::new();
context.insert("total".to_string(), json!(150.0));

let result = engine.evaluate(&context).unwrap();

Implementations§

Source§

impl RuleEngine

Source

pub fn new() -> Self

Create a new rule engine with default knowledge base

Source

pub fn with_config(config: EngineConfig) -> Self

Create a new rule engine with custom configuration

Source

pub fn add_grl_rule(&mut self, grl_content: &str) -> Result<(), RuleError>

Add rules from GRL syntax

§Example
use rust_logic_graph::RuleEngine;

let mut engine = RuleEngine::new();
let grl = r#"
    rule "high_value_order" {
        salience 100
        when
            order_amount > 1000
        then
            priority = "high";
            requires_approval = true;
    }
"#;
engine.add_grl_rule(grl).unwrap();
Source

pub fn evaluate(&mut self, context: &HashMap<String, JsonValue>) -> RuleResult

Evaluate rules with JSON context (convenience method)

For more control, use inner() or inner_mut() to access the underlying RustRuleEngine directly.

§Example
use rust_logic_graph::RuleEngine;
use std::collections::HashMap;
use serde_json::json;

let mut engine = RuleEngine::new();
// ... add rules ...

let mut context = HashMap::new();
context.insert("total".to_string(), json!(150.0));

let result = engine.evaluate(&context).unwrap();
Source

pub fn from_grl(grl_script: &str) -> Result<Self, RuleError>

Create a rule engine from GRL script

§Example
use rust_logic_graph::RuleEngine;

let grl = r#"
    rule "example" {
        salience 100
        when
            x > 0
        then
            y = x * 2;
    }
"#;

let mut engine = RuleEngine::from_grl(grl).unwrap();
Source

pub fn inner(&self) -> &RustRuleEngine

Get reference to underlying RustRuleEngine for advanced usage

This provides full access to rust-rule-engine features:

  • Custom functions
  • Templates
  • Globals
  • Deffacts
  • Fine-grained control
Source

pub fn inner_mut(&mut self) -> &mut RustRuleEngine

Get mutable reference to underlying RustRuleEngine

Trait Implementations§

Source§

impl Default for RuleEngine

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more