SbeSourceGenerator 1.1.3

SBE Source Generator

A Roslyn incremental source generator that converts FIX Simple Binary Encoding (SBE) XML schemas into high-performance, zero-allocation C# structs. Ideal for real-time market data, trading systems, and any latency-sensitive binary protocol.

Getting Started

1. Install the package:

   dotnet add package SbeSourceGenerator
   

2. Add your SBE schema files as AdditionalFiles:

   <ItemGroup>
     <AdditionalFiles Include="Schemas\*.xml" />
   </ItemGroup>
   

3. Build. Generated code is available at compile time — no runtime reflection, no code-behind files.

Quick Example

// Decode (with groups and varData) — zero-copy via MessageDataReader
if (OrderData.TryParse(buffer, out var reader))
{
    Console.WriteLine($"Order {reader.Data.OrderId} @ {reader.Data.Price}");
    reader.ReadGroups(/* group/varData callbacks */);
}

// Encode (simple message — no groups)
OrderData order = default;
order.OrderId = 42;
order.Price = 100_00;
order.TryEncode(buffer, out int bytesWritten);

// Encode (with groups)
OrderBookData.TryEncode(orderBook, buffer, bids, asks, out int bytesWritten);

Features

• Zero-copy blittable structs — [StructLayout(Explicit)] with [FieldOffset], directly overlay on buffers
• TryParse / TryEncode — safe decode/encode with zero-copy MessageDataReader and group/varData support
• Zero-copy decode — TryReadBlock<T> and ReadBlockRef<T> read directly from spans
• in delegate callbacks — group iteration passes structs by readonly reference (no copies)
• Schema evolution — TryReadBlock handles blockLength mismatches (forward/backward compat)
• Big-endian support — automatic byte swapping for big-endian schemas
• Enums, sets, composites — full SBE type system with optional field support
• Nested groups — recursive group generation to any depth
• SpanReader / SpanWriter — embedded sequential binary reader/writer (no manual offset tracking)
• Cross-schema coexistence — multiple schemas generate isolated namespaces, no conflicts
• AOT / trimming compatible — no reflection, no dynamic code generation
• Roslyn diagnostics — SBE001–SBE014 for schema validation at build time

Requirements

• .NET 6.0+ for consumer projects (generator itself targets netstandard2.0)
• SBE XML schema using the FIX SBE 1.0 namespace (http://fixprotocol.io/2016/sbe)

Performance

All generated code targets zero allocations on hot paths:

• Structs are stack-allocated value types
• readonly property getters prevent defensive copies through in/ref readonly
• Group callbacks use in delegates — no boxing, no struct copies
• SpanReader/SpanWriter are ref struct with [MethodImpl(AggressiveInlining)]

Documentation

Full documentation at github.com/pedrosakuma/SbeSourceGenerator:

• Schema Versioning Guide
• SpanReader API
• Performance Tuning

Contributing

Issues and pull requests are welcome at github.com/pedrosakuma/SbeSourceGenerator.

License

Distributed under the MIT License. See LICENSE.txt for details.