Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

rulesengine

package module

Go to main page

Versions in this module

v0

v0.2.2

Oct 22, 2024

v0.2.1

Oct 22, 2024

Changes in this version

+ const FINISHED

+ const READY

+ const RUNNING

+ func Debug(message string)

+ func EvalEndsWith(a, b *ValueNode) bool

+ func EvalEqual(a, b *ValueNode) bool

+ func EvalGreaterOrEqual(a, b *ValueNode) bool

+ func EvalGreaterThan(a, b *ValueNode) bool

+ func EvalIn(a, b *ValueNode) bool

+ func EvalIncludes(a, b *ValueNode) bool

+ func EvalLessThan(a, b *ValueNode) bool

+ func EvalLessThanOrEqual(a, b *ValueNode) bool

+ func EvalNotEquals(a, b *ValueNode) bool

+ func EvalNotIn(a, b *ValueNode) bool

+ func EvalStartsWith(a, b *ValueNode) bool

+ func HashString(data string) uint64

+ func IsObjectLike(value interface{}) bool

+ type Almanac struct

+ func NewAlmanac(rf gjson.Result, options Options, initialCapacity int) *Almanac

+ func (a *Almanac) AddEvent(event Event, outcome EventOutcome) error

+ func (a *Almanac) AddFact(key string, value *Fact)

+ func (a *Almanac) AddResult(ruleResult *RuleResult)

+ func (a *Almanac) AddRuntimeFact(path string, value ValueNode) error

+ func (a *Almanac) FactValue(path string) (*Fact, error)

+ func (a *Almanac) GetEvents(outcome EventOutcome) *[]Event

+ func (a *Almanac) GetResults() []RuleResult

+ func (a *Almanac) GetValue(path string) (interface{}, error)

+ type Condition struct

+ All []*Condition

+ Any []*Condition

+ Condition string

+ Fact string

+ FactResult Fact

+ Name string

+ Not *Condition

+ Operator string

+ Params map[string]interface{}

+ Priority *int

+ Result bool

+ Value ValueNode

+ func (c *Condition) Evaluate(almanac *Almanac, operatorMap map[string]Operator) (*EvaluationResult, error)

+ func (c *Condition) IsBooleanOperator() bool

+ func (c *Condition) IsConditionReference() bool

+ func (c *Condition) ToJSON(stringify bool) (interface{}, error)

+ func (c *Condition) UnmarshalJSON(data []byte) error

+ func (c *Condition) Validate() error

+ type ConditionMap struct

+ func (m *ConditionMap) Load(key string) (Condition, bool)

+ func (m *ConditionMap) Store(key string, value Condition)

+ type ConditionProperties struct

+ Fact string

+ Name *string

+ Operator string

+ Params map[string]interface{}

+ Path *string

+ Priority *int

+ Value interface{}

+ func (c *ConditionProperties) SetName(name string)

+ func (c *ConditionProperties) SetPriority(priority int)

+ type DataType int

+ const Array

+ const Bool

+ const Null

+ const Number

+ const Object

+ const String

+ type DynamicFactCallback func(almanac *Almanac, params ...interface{}) *ValueNode

+ type Engine struct

+ AllowUndefinedConditions bool

+ AllowUndefinedFacts bool

+ Conditions ConditionMap

+ Facts FactMap

+ Operators map[string]Operator

+ ReplaceFactsInEventParams bool

+ Rules []*Rule

+ Status string

+ func NewEngine(rules []*Rule, options *RuleEngineOptions) *Engine

+ func (e *Engine) AddCalculatedFact(path string, method DynamicFactCallback, options *FactOptions) error

+ func (e *Engine) AddFact(path string, value *ValueNode, options *FactOptions) error

+ func (e *Engine) AddOperator(operatorOrName interface{}, cb func(*ValueNode, *ValueNode) bool)

+ func (e *Engine) AddRule(rule *Rule) error

+ func (e *Engine) AddRuleFromMap(rp *RuleConfig) error

+ func (e *Engine) AddRules(rules []*Rule) error

+ func (e *Engine) EvaluateRules(rules []*Rule, almanac *Almanac, ctx *ExecutionContext) error

+ func (e *Engine) GetFact(path string) *Fact

+ func (e *Engine) GetRules() []*Rule

+ func (e *Engine) PrioritizeRules() [][]*Rule

+ func (e *Engine) RemoveCondition(name string) bool

+ func (e *Engine) RemoveFact(path string) bool

+ func (e *Engine) RemoveOperator(operatorOrName interface{}) bool

+ func (e *Engine) RemoveRule(rule *Rule) bool

+ func (e *Engine) RemoveRuleByName(name string) bool

+ func (e *Engine) Run(ctx context.Context, input []byte) (map[string]interface{}, error)

+ func (e *Engine) RunWithMap(ctx context.Context, input map[string]interface{}) (map[string]interface{}, error)

+ func (e *Engine) Stop() *Engine

+ func (e *Engine) UpdateRule(r *Rule) error

+ type EvaluationResult struct

+ LeftHandSideValue Fact

+ Operator string

+ Result bool

+ RightHandSideValue interface{}

+ type Event struct

+ Params map[string]interface{}

+ Type string

+ type EventCallback func(result *RuleResult) interface

+ type EventConfig struct

+ Params *map[string]interface{}

+ Type string

+ type EventHandler func(event Event, almanac Almanac, ruleResult RuleResult)

+ type EventOutcome string

+ const Failure

+ const Success

+ type ExecutionContext struct

+ Cancel context.CancelFunc

+ Errors []error

+ Message string

+ StopEarly bool

+ func NewEvaluationContext(ctx context.Context) *ExecutionContext

+ func (c *ExecutionContext) AddError(err error)

+ type Fact struct

+ Cached bool

+ CalculationMethod DynamicFactCallback

+ Dynamic bool

+ Path string

+ Priority int

+ Value *ValueNode

+ func NewCalculatedFact(path string, method DynamicFactCallback, options *FactOptions) *Fact

+ func NewFact(path string, value ValueNode, options *FactOptions) (*Fact, error)

+ func (f *Fact) Calculate(almanac *Almanac, params ...interface{}) *Fact

+ type FactMap struct

+ func (m *FactMap) Delete(key string)

+ func (m *FactMap) Load(key string) (*Fact, bool)

+ func (m *FactMap) LoadOrStore(key string, value *Fact) (*Fact, bool)

+ func (m *FactMap) Range(f func(key string, value *Fact) bool)

+ func (m *FactMap) Set(key string, value *Fact)

+ type FactOptions struct

+ Cache bool

+ Priority int

+ type InvalidRuleError struct

+ Code string

+ Message string

+ func NewInvalidPriorityTypeError() *InvalidRuleError

+ func NewInvalidPriorityValueError() *InvalidRuleError

+ func NewInvalidRuleError(message string, code string) *InvalidRuleError

+ func NewPriorityNotSetError() *InvalidRuleError

+ func (e *InvalidRuleError) Error() string

+ type Operator struct

+ Callback func(a, b *ValueNode) bool

+ FactValueValidator func(factValue *ValueNode) bool

+ Name string

+ func DefaultOperators() []Operator

+ func NewOperator(name string, cb func(a, b *ValueNode) bool, ...) (*Operator, error)

+ func (o *Operator) Evaluate(a, b *ValueNode) bool

+ type Options struct

+ AllowUndefinedFacts *bool

+ type Rule struct

+ Conditions Condition

+ Engine *Engine

+ Name string

+ Priority int

+ RuleEvent Event

+ func NewRule(config *RuleConfig) (*Rule, error)

+ func (r *Rule) Evaluate(ctx *ExecutionContext, almanac *Almanac) (*RuleResult, error)

+ func (r *Rule) GetConditions() *Condition

+ func (r *Rule) GetEngine() *Engine

+ func (r *Rule) GetEvent() Event

+ func (r *Rule) GetPriority() int

+ func (r *Rule) SetEngine(engine *Engine)

+ func (r *Rule) ToJSON(stringify bool) (interface{}, error)

+ type RuleConfig struct

+ Conditions Condition

+ Event EventConfig

+ Name string

+ OnFailure func(result *RuleResult) interface{}

+ OnSuccess func(result *RuleResult) interface{}

+ Priority *int

+ func (r *RuleConfig) UnmarshalJSON(data []byte) error

+ type RuleEngineOptions struct

+ AllowUndefinedConditions bool

+ AllowUndefinedFacts bool

+ ReplaceFactsInEventParams bool

+ func DefaultRuleEngineOptions() *RuleEngineOptions

+ type RuleProperties struct

+ Conditions TopLevelCondition

+ Event Event

+ Name *string

+ OnFailure *EventHandler

+ OnSuccess *EventHandler

+ Priority *int

+ type RuleResult struct

+ Conditions Condition

+ Event Event

+ Name string

+ Priority int

+ Result *bool

+ func NewRuleResult(conditions Condition, event Event, priority int, name string) *RuleResult

+ func (rr *RuleResult) ResolveEventParams(almanac *Almanac) error

+ func (rr *RuleResult) SetResult(result *bool)

+ func (rr *RuleResult) ToJSON(stringify bool) (interface{}, error)

+ type TopLevelCondition struct

+ All *[]ConditionProperties

+ Any *[]ConditionProperties

+ Condition *string

+ Name *string

+ Not *ConditionProperties

+ Priority *int

+ type UndefinedFactError struct

+ Code string

+ Message string

+ func NewUndefinedFactError(message string) *UndefinedFactError

+ func (e *UndefinedFactError) Error() string

+ type ValueNode struct

+ Array []ValueNode

+ Bool bool

+ Number float64

+ Object map[string]ValueNode

+ String string

+ Type DataType

+ func NewValueFromGjson(result gjson.Result) *ValueNode

+ func (v *ValueNode) IsArray() bool

+ func (v *ValueNode) IsBool() bool

+ func (v *ValueNode) IsNull() bool

+ func (v *ValueNode) IsNumber() bool

+ func (v *ValueNode) IsObject() bool

+ func (v *ValueNode) IsString() bool

+ func (v *ValueNode) Raw() interface{}

+ func (v *ValueNode) SameType(other *ValueNode) bool

+ func (v *ValueNode) UnmarshalJSON(data []byte) error

v0.2.0

Oct 22, 2024

v0.1.0

Jul 26, 2024