Cysharp/MemoryPack
MemoryPack
MemoryPack is a high-performance binary serialization library for C# and Unity. It provides a zero-allocation data pipeline and a schema-evolution framework designed to minimize memory allocations and encoding overhead.
The project utilizes compile-time source generators to avoid runtime reflection and implements a zero-encoding binary format for maximum throughput. It distinguishes itself through a zero-allocation approach that reuses object instances to reduce garbage collection pressure and copies the memory layout of unmanaged structs directly to binary streams.
The library covers binary schema versioning for backward compatibility and supports asynchronous collection streaming for large datasets. It includes a TypeScript type generator to synchronize data structures between C# and TypeScript for cross-language data exchange. Additional capabilities include payload compression, custom formatter implementations, and serialization callbacks.
Features
- High-Performance Binary Serialization - Provides an optimized binary serialization engine for C# designed for minimal CPU and memory overhead.
- Direct-Memory Struct Copying - Implements high-speed serialization by copying the memory layout of blittable structs directly to the output stream.
- Schema Versioning - Ensures backward compatibility by tracking member additions and handling schema mismatches between data versions.
- Schema Evolution - Supports adding new members to serialized objects while maintaining compatibility with older data versions.
- Binary Serialization Versioning - Ensures that new software versions can read older binary data through robust schema versioning.
- Blittable Struct Serializations - Writes the memory layout of unmanaged structs directly to binary streams for maximum processing speed.
- Memory Optimization Techniques - Reduces GC pressure through object reuse and direct raw struct serialization in C#.
- Zero-Allocation Binary IO - Implements a memory-efficient binary IO pipeline that minimizes allocations during serialization and deserialization.
- Serialization Code Generators - Utilizes compile-time source generators to create static serialization logic and eliminate runtime reflection overhead.
- Object Serialization - Provides high-performance conversion of plain C# objects into a binary format and back.
- Object Instance Reuses - Provides the ability to deserialize data into existing object instances to minimize memory allocations and GC frequency.
- Buffer-Reusing Serializers - Minimizes garbage collection pressure by reusing existing object instances during the deserialization process.
- Zero-Encoding Binary Formats - Writes data directly to binary streams without intermediate transformation to achieve maximum processing throughput.
- Custom Serializer Implementations - Allows the definition of manual serialization logic for external types by implementing custom formatter classes.
- TypeScript Type Generators - Generates TypeScript interfaces from C# type definitions to maintain consistent data models.
- C# to TypeScript Generators - Provides a utility to convert C# types into TypeScript interfaces for consistent cross-language data exchange.
- Payload Compressions - Reduces binary size using compression algorithms to minimize the volume of data transmitted across the network.
- Cross-Language Data Exchange - Synchronizes data structures between C# and TypeScript to ensure type-safe API communication.
- Collection Streaming - Processes massive object arrays using asynchronous streams to prevent high memory consumption.
- Unity Serialization Libraries - Optimizes Unity game state persistence by using fast binary serialization for reduced load times.
- Serialization Libraries - Zero-copy binary serialization for .NET.
