AyCode.Core/AyCode.Core.Serializers.Sou...
Loretta 03d606164c Overhaul SignalR/DataSource docs, update all references
- Added SIGNALR.md (transport) and SIGNALR_DATASOURCE.md (collection) as layered, comprehensive documentation; retired SIGNALR_ARCHITECTURE.md
- Updated all .md files and READMEs to reference new docs and clarify separation between transport and DataSource
- Clarified CRUD tag structure (5 independent tags), single-method tag-based dispatch, and JSON-in-Binary tech debt
- Added slot allocation and wire format clarifications to serialization docs
- Improved documentation layering, conventions, and critical warnings for future maintainers
2026-03-29 18:28:52 +02:00
..
AcBinarySourceGenerator.cs Optimize scan codegen with compile-time property checks 2026-03-10 18:35:25 +01:00
AyCode.Core.Serializers.SourceGenerator.csproj Add AcBinary Source Generator for fast serialization 2026-01-06 08:58:34 +01:00
README.md Overhaul SignalR/DataSource docs, update all references 2026-03-29 18:28:52 +02:00

README.md

AyCode.Core.Serializers.SourceGenerator

Roslyn incremental source generator that produces optimized IGeneratedBinaryWriter and IGeneratedBinaryReader implementations for types marked with [AcBinarySerializable]. Eliminates runtime reflection on serialization hot paths.

Targets netstandard2.0 (required for Roslyn analyzers/generators).

Key Files

  • AcBinarySourceGenerator.cs — Single-file IIncrementalGenerator (~2100 lines). Generates:
    • {ClassName}_GeneratedWriter — Per-type writer with ScanObject() + WriteProperties() methods. Handles primitives, strings (with interning), collections, dictionaries, complex nested types, and polymorphic objects.
    • {ClassName}_GeneratedReader — Per-type reader with ReadProperties() method.
    • ModuleInitializer — Auto-registers all generated writers/readers at startup.
    • Circular reference detection with ACBIN001 diagnostic warning.

Slot Allocation

Each generated writer reserves a unique type slot via AcBinarySerializer.AllocateWrapperSlot() (static field initializer, Interlocked.Increment).

  • Slots 063 — reserved for runtime polymorphic types (assigned dynamically on first encounter)
  • Slots 64+ — source-generated types (allocated at [ModuleInitializer] registration time)

Slot indices are NOT stable across compilations. The order depends on Roslyn's ForAttributeWithMetadataName() enumeration order, which may vary between builds. This is fine because slots are only meaningful within a single serialization/deserialization session — they are never persisted to disk or sent over the wire as slot indices (the wire format uses type names or metadata hashes for cross-session/cross-type compatibility).

Feature Flags

The [AcBinarySerializable] attribute supports per-type feature control:

  • enableMetadata — Property hash metadata for cross-type deserialization
  • enableIdTracking — IId-based reference tracking
  • enableRefHandling — General reference tracking
  • enableInternString — String interning/deduplication

Disabled features eliminate corresponding code blocks from generated output (zero dead code).

Dependencies

Dependency Purpose
Microsoft.CodeAnalysis.CSharp Roslyn syntax/semantic APIs
Microsoft.CodeAnalysis.Analyzers Analyzer best practices