MessagePack-CSharp/MessagePack-CSharp
MessagePack CSharp
MessagePack-CSharp is a high-performance binary serializer for .NET that converts C# objects to and from the compact MessagePack format. It uses compile-time source generation to produce AOT-safe formatters and resolvers, eliminating runtime reflection and enabling ahead-of-time compilation scenarios. The serializer encodes object fields as integer indices instead of string keys, producing compact binary output with deterministic field ordering, and provides stack-allocated reader and writer structs for direct encoding and decoding of MessagePack primitives without heap allocations.
The library distinguishes itself through its LZ4 block compression pipeline, which reduces binary size while maintaining high throughput, and its priority-chained resolver composition that allows combining multiple formatter resolvers in a fixed order for fallback and override of serialization logic. It supports version-tolerant deserialization by ignoring unknown keys and applying default values, and can embed full .NET type names into the binary blob for polymorphic serialization of interface-typed or abstract-typed objects. A stream-boundary-aware reader detects consecutive MessagePack structures from a single stream, enabling multiplexed or chunked data processing.
The serializer handles a broad range of data scenarios, including conversion between MessagePack and JSON for debugging and interoperability, serialization of Unity-specific structs like Vector3 and Quaternion, and dynamic or untyped data handling through union attributes. It provides compile-time validation via analyzers to detect incorrect attribute usage, and supports custom IMessagePackFormatter implementations for types requiring special handling. String interning during deserialization reuses repeated string objects to lower memory usage for repetitive data.
Features
- MessagePack Serializers - Provides high-performance MessagePack binary serialization for .NET objects with customizable resolvers.
- Primitive Type Encoding - Provides low-level reader and writer structs for direct zero-allocation MessagePack primitive encoding.
- Object Deserialization - Reconstructs C# objects from MessagePack binary with support for immutable types and records.
- Object Serialization - Converts annotated C# classes and structs into compact MessagePack binary using index or string keys.
- Resolver Composition - Combines multiple formatter resolvers in priority order to control type serialization behavior.
- Compile-Time Code Generation - Generates AOT-safe formatters and resolvers at compile time using Roslyn source generators.
- AOT-Safe Serialization Generators - Generates compile-time formatters and resolvers for AOT-safe serialization, eliminating runtime reflection.
- Zero-Allocation Readers - Provides stack-allocated reader and writer structs for zero-allocation primitive encoding.
- Priority-Chained Resolvers - Combines multiple formatter resolvers in priority order for fallback and override of serialization logic.
- Integer Key Encoders - Encodes object fields as integer indices for compact binary output with deterministic ordering.
- Version-Tolerant Deserializers - Deserializes binary data with missing or extra fields by ignoring unknown keys and applying defaults.
- Type-Embedded Binary Codecs - Embeds full .NET type names into serialized blobs for type-argument-free deserialization.
- Binary-to-JSON Converters - Transforms MessagePack binary data into human-readable JSON and back for debugging and interoperability.
- Data Format Interoperability - Converts between MessagePack binary and JSON for debugging and interoperability.
- LZ4 Compression Pipelines - Applies LZ4 block compression during serialization to reduce binary size with high throughput.
- Dynamic Serialization - Serializes and deserializes objects without predefined schemas via union attributes.
- Custom Type Serializers - Allows writing custom IMessagePackFormatter implementations for types needing special handling.
- Polymorphic Type Serializers - Embeds .NET type names or uses union attributes to serialize and deserialize polymorphic objects.
- Type-Embedded Polymorphism - Embeds .NET type names in binary for polymorphic deserialization without explicit type arguments.
- Stream Message Boundary Preservation - Reads consecutive MessagePack structures from a single stream by detecting boundaries.
- High-Speed Block Compression - Applies LZ4 block compression as a serialization layer to reduce binary size.
- LZ4 Compression Pipelines - Applies LZ4 block compression during serialization to reduce binary size with high throughput.
- Dynamic Object Serializers - Serializes and deserializes objects without predefined schemas, including anonymous and interface-typed objects.
- Unity Struct Serializers - Serializes Unity structs like Vector3 and Quaternion using built-in resolvers for server-client communication.
- Custom Serialization Logic - Supports custom IMessagePackFormatter implementations for types needing special serialization logic.
- Serialization Libraries - Extremely fast MessagePack serializer for .NET.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
