Skip to content

ZeroAlloc-Net/ZeroAlloc.Pipeline

Repository files navigation

ZeroAlloc.Pipeline

NuGet Build License: MIT AOT GitHub Sponsors

ZeroAlloc.Pipeline is the shared building block for pipeline-aware source generators in the ZeroAlloc ecosystem. It provides the IPipelineBehavior marker interface, PipelineBehaviorAttribute, and the Roslyn-based discovery, validation, and code-emission utilities that generators like ZeroAlloc.Mediator and ZeroAlloc.Validation build on. All pipeline wiring is resolved at compile time — no reflection, no virtual dispatch, no heap allocation per call.

Multiple packages in this family — see Documentation or NuGet for the full list.

Install

dotnet add package ZeroAlloc.Pipeline
dotnet add package ZeroAlloc.Pipeline.Generators
<PackageReference Include="ZeroAlloc.Pipeline" Version="*" />
<PackageReference Include="ZeroAlloc.Pipeline.Generators" Version="*"
                  OutputItemType="Analyzer"
                  ReferenceOutputAssembly="false" />

Example

using ZeroAlloc.Pipeline;

// 1. Implement IPipelineBehavior and decorate with [PipelineBehavior]
[PipelineBehavior(Order = 1)]
public class LoggingBehavior : IPipelineBehavior
{
    // 2. Expose a public static Handle method matching the host framework's delegate shape
    public static async ValueTask<TResponse> Handle<TRequest, TResponse>(
        TRequest request,
        CancellationToken ct,
        Func<TRequest, CancellationToken, ValueTask<TResponse>> next)
    {
        Console.WriteLine($"Handling {typeof(TRequest).Name}");
        var response = await next(request, ct);
        Console.WriteLine($"Handled {typeof(TRequest).Name}");
        return response;
    }
}

// 3. The host generator (e.g. ZeroAlloc.Mediator) picks this up at compile time
//    and wires it into the generated pipeline — no registration required.

Performance

ZeroAlloc.Pipeline emits static nested lambda chains. Static lambdas carry no closure allocation, and the JIT inlines static call chains aggressively — collapsing N behaviors into straight-line code.

1 behavior 3 behaviors 5 behaviors Allocated
Static chain 4.1 ns 2.3 ns 2.8 ns 0 B
Pre-built delegate chain 2.2 ns 9.9 ns 17.6 ns 0 B
Speedup 0.5× 4.3× 6.4×

BenchmarkDotNet v0.15.8, .NET 10.0.4, 12th Gen Intel Core i9-12900HK — tests/ZeroAlloc.Pipeline.Benchmarks

Features

  • IPipelineBehavior — marker interface; no contract imposed on Handle signature
  • PipelineBehaviorAttributeOrder (execution position) and AppliesTo (type scoping)
  • Attribute subclassing — framework packages define their own alias; discovery follows the inheritance chain
  • Compile-time discoveryPipelineBehaviorDiscoverer and FromAttributeSyntaxContext for incremental generators
  • Static emitterPipelineEmitter.EmitChain generates a nested static lambda chain from a behavior list and a PipelineShape
  • PipelineShape — describes type arguments, parameter names, and the innermost body; supports a factory delegate when the body embeds depth-indexed lambda names
  • Diagnostic helpersPipelineDiagnosticRules.FindMissingHandleMethod and FindDuplicateOrders return offending behaviors; the caller maps them to framework-specific diagnostic IDs
  • Zero allocation — no reflection, no boxing, no delegate list per call
  • netstandard2.0 + Native AOT — works in trimmed, ahead-of-time compiled applications

Documentation

Page Description
Getting Started Write your first behavior and see it get picked up
Pipeline Behaviors IPipelineBehavior, PipelineBehaviorAttribute, ordering, scoping
Pipeline Shape Describe the delegate shape for code generation
Pipeline Emitter Generate a nested static lambda call chain
Pipeline Discoverer Discover behaviors at compile time
Diagnostics ZAP001, ZAP002 diagnostic rules reference
Performance Why static lambda chains allocate nothing
Testing Test behaviors and generators built on this library

License

MIT

About

Shared building block for pipeline-aware Roslyn source generators in the ZeroAlloc ecosystem. Zero allocation, compile-time wiring, Native AOT compatible.

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages