UUID.Serialization.MessagePack 1.0.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.8 This package targets .NET Framework 4.8. The package is compatible with this framework or higher.
Suggested Alternatives

UUID.Serialization.MessagePack 1.1.0

There is a newer version of this package available.
See the version list below for details. 
dotnet add package UUID.Serialization.MessagePack --version 1.0.1                

                    
                

            
NuGet\Install-Package UUID.Serialization.MessagePack -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="UUID.Serialization.MessagePack" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add UUID.Serialization.MessagePack --version 1.0.1                

                    
                

            
#r "nuget: UUID.Serialization.MessagePack, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install UUID.Serialization.MessagePack as a Cake Addin
#addin nuget:?package=UUID.Serialization.MessagePack&version=1.0.1

// Install UUID.Serialization.MessagePack as a Cake Tool
#tool nuget:?package=UUID.Serialization.MessagePack&version=1.0.1

UUID.Serialization.MessagePack

A MessagePack serialization provider for the UUID library.

Installation

dotnet add package UUID.Serialization.MessagePack

Usage

Basic Usage

using MessagePack;
using MessagePack.Resolvers;

// Register the resolver globally
var options = MessagePackSerializerOptions.Standard
    .WithResolver(CompositeResolver.Create(
        UUIDResolver.Instance,
        StandardResolver.Instance
    ));

// Serialize
var uuid = new UUID();
byte[] bytes = MessagePackSerializer.Serialize(uuid, options);

// Deserialize
UUID deserializedUuid = MessagePackSerializer.Deserialize<UUID>(bytes, options);

With Models

public class UserModel
{
    [Key(0)]
    public UUID Id { get; set; }
    
    [Key(1)]
    public string Name { get; set; }
}

// Register resolver
var options = MessagePackSerializerOptions.Standard
    .WithResolver(CompositeResolver.Create(
        UUIDResolver.Instance,
        StandardResolver.Instance
    ));

// Serialize model
var user = new UserModel 
{ 
    Id = new UUID(),
    Name = "John Doe"
};
byte[] bytes = MessagePackSerializer.Serialize(user, options);

// Deserialize model
UserModel deserializedUser = MessagePackSerializer.Deserialize<UserModel>(bytes, options);

Features

  • Support for null handling
  • Thread-safe implementation
  • Comprehensive error handling
  • Efficient binary serialization
  • Full documentation with XML comments
  • Seamless integration with MessagePack
  • Custom error messages for better debugging

Error Handling

The formatter provides detailed error messages for common scenarios:

  • Null values: "Cannot convert null value to UUID"
  • Invalid byte length: "UUID must be exactly 16 bytes long"
  • Incorrect MessagePack types: Shows expected vs actual type
  • Invalid binary format: Includes details about the attempted deserialization

Requirements

  • UUID library
  • MessagePack 2.5.129 or later
  • Supports .NET 6.0+, .NET Standard 2.0+, and .NET Framework 4.8+

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the terms of the LICENSE file included in the root directory.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

All changes are detailed at https://github.com/Taiizor/UUID/wiki/Changelog.