OutWit.Common.MessagePack

A utility library for the MessagePack-CSharp serializer. It simplifies common serialization tasks, provides helpful extension methods, and includes a set of pre-configured, serializable data structures for common use cases.

Features

• Simple Serialization/Deserialization: Extension methods (ToMessagePackBytes, FromMessagePackBytes) to serialize and deserialize any object with a single line of code.
• Built-in Compression: Easily enable or disable LZ4 compression via a boolean flag.
• Deep Cloning: A convenient .MessagePackClone() extension method to perform a deep copy of any serializable object.
• Centralized Configuration: A simple static class MessagePackUtils for registering custom formatters and resolvers globally.
• Custom Formatters Included:
  • TypeFormatter: Serializes System.Type objects.
  • PropertyChangedEventArgsFormatter: Serializes System.ComponentModel.PropertyChangedEventArgs.
• File I/O Helpers: Methods to easily export and load collections to/from a MessagePack file.

Installation

Install the package via the .NET CLI:

dotnet add package OutWit.Common.MessagePack

Quick Start

The library is configured with sensible defaults and is ready to use immediately after installation.

Basic Serialization and Deserialization

The MessagePackUtils class provides extension methods for any object.

using OutWit.Common.MessagePack; public class MyData { public int Id { get; set; } public string Name { get; set; } } var myObject = new MyData { Id = 1, Name = "Test" }; // Serialize the object to a byte array (with LZ4 compression by default) byte[] msgPackBytes = myObject.ToMessagePackBytes(); // Deserialize it back MyData deserializedObject = msgPackBytes.FromMessagePackBytes<MyData>();