API Reference
Complete reference for all RoslynRules public APIs, organized by component.
Quick Navigation
Core Models
| Class | Purpose |
|---|---|
| Rule | Individual rule with Expression, Action, child rules |
| Workflow | Container for top-level rules |
| RuleResult | Execution result with child traceability |
| RuleParameter | Parameter definition (name, type, value) |
| RuleDiagnostics | Diagnostics, logging, and auditing model |
| RuleLifecycleEvents | OnRuleExecuting/OnRuleExecuted event args |
| CompiledDelegate | Fast invocation wrapper for compiled delegates |
Execution & Context
| Class | Purpose |
|---|---|
| RuleContext | Access dependency rule results during execution |
| IRuleEngine | Abstraction for DI and mocking |
| RuleBatch | Batch evaluation for 10+ rules |
| GraphAlgorithms | Topological sort for dependency resolution |
Compilation
| Class | Purpose |
|---|---|
| ExpressionCompiler | Compile C# expressions to typed delegates |
| Delegate Types | Supported expression signatures |
Configuration & Data
| Class | Purpose |
|---|---|
| JSON Serialization | Save/load rules from JSON |
| Rule Templates | Reusable parameterized rule templates |
| Rule Predicates | Built-in validation factory methods |
Runtime Features
| Topic | Purpose |
|---|---|
| Rule Priority | Control execution order |
| Lifecycle Events | Pre/post execution hooks |
| Result Caching | Memoization for expensive rules |
Exceptions & Diagnostics
| Class | Purpose |
|---|---|
| Exceptions | Typed exception hierarchy |
| ValidationError | Structured validation errors |
Looking for examples? See the Examples section for real-world use cases.
Table of contents
- Rule
- Workflow
- RuleResult
- RuleParameter
- Exceptions
- ExpressionCompiler
- RuleDiagnostics
- Delegate Types
- GraphAlgorithms
- JSON Serialization
- RuleLifecycleEvents
- CompiledDelegate
- Rule Templates
- Rule Predicates
- RuleContext
- IRuleEngine
- Rule Localization
- Rule Visualization
- RuleBatch
- Rule Priority
- Lifecycle Events
- Result Caching
- AssemblyReferenceProvider
- Rule Metrics