API Reference

Complete reference for all RoslynRules public APIs, organized by component.

Quick Navigation

Core Models

ClassPurpose
RuleIndividual rule with Expression, Action, child rules
WorkflowContainer for top-level rules
RuleResultExecution result with child traceability
RuleParameterParameter definition (name, type, value)
RuleDiagnosticsDiagnostics, logging, and auditing model
RuleLifecycleEventsOnRuleExecuting/OnRuleExecuted event args
CompiledDelegateFast invocation wrapper for compiled delegates

Execution & Context

ClassPurpose
RuleContextAccess dependency rule results during execution
IRuleEngineAbstraction for DI and mocking
RuleBatchBatch evaluation for 10+ rules
GraphAlgorithmsTopological sort for dependency resolution

Compilation

ClassPurpose
ExpressionCompilerCompile C# expressions to typed delegates
Delegate TypesSupported expression signatures

Configuration & Data

ClassPurpose
JSON SerializationSave/load rules from JSON
Rule TemplatesReusable parameterized rule templates
Rule PredicatesBuilt-in validation factory methods

Runtime Features

TopicPurpose
Rule PriorityControl execution order
Lifecycle EventsPre/post execution hooks
Result CachingMemoization for expensive rules

Exceptions & Diagnostics

ClassPurpose
ExceptionsTyped exception hierarchy
ValidationErrorStructured validation errors

Looking for examples? See the Examples section for real-world use cases.


Table of contents


Back to top

MIT License. Built with Roslyn + Typed Delegates.