UUID.Serialization.Newtonsoft 1.0.7

.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. 
dotnet add package UUID.Serialization.Newtonsoft --version 1.0.7                

                    
                

            
NuGet\Install-Package UUID.Serialization.Newtonsoft -Version 1.0.7
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.Newtonsoft" Version="1.0.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add UUID.Serialization.Newtonsoft --version 1.0.7                

                    
                

            
#r "nuget: UUID.Serialization.Newtonsoft, 1.0.7"
#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.Newtonsoft as a Cake Addin
#addin nuget:?package=UUID.Serialization.Newtonsoft&version=1.0.7

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

UUID.Serialization.Newtonsoft

A Newtonsoft.Json serialization provider for the UUID library.

Installation

dotnet add package UUID.Serialization.Newtonsoft

Usage

Basic Usage

using Newtonsoft.Json;

// Register the converter globally
JsonSerializerSettings settings = new()
{
    Converters = { new UUIDConverter() }
};

// Serialize
var uuid = new UUID();
string json = JsonConvert.SerializeObject(uuid, settings);

// Deserialize
UUID deserializedUuid = JsonConvert.DeserializeObject<UUID>(json, settings);

With Models

public class UserModel
{
    public UUID Id { get; set; }
    public string Name { get; set; }
}

// Register converter
JsonSerializerSettings settings = new()
{
    Converters = { new UUIDConverter() }
};

// Serialize model
var user = new UserModel 
{ 
    Id = new UUID(),
    Name = "John Doe"
};
string json = JsonConvert.SerializeObject(user, settings);

// Deserialize model
UserModel deserializedUser = JsonConvert.DeserializeObject<UserModel>(json, settings);

Using Attributes

public class UserModel
{
    [JsonConverter(typeof(UUIDConverter))]
    public UUID Id { get; set; }
    public string Name { get; set; }
}

// No need to register converter globally
var user = new UserModel 
{ 
    Id = new UUID(),
    Name = "John Doe"
};
string json = JsonConvert.SerializeObject(user);

Features

  • Seamless integration with Newtonsoft.Json
  • Efficient string conversion
  • Comprehensive error handling
  • Thread-safe implementation
  • Full documentation with XML comments
  • Support for null handling
  • Custom error messages for better debugging
  • Support for JsonConverter attribute

Error Handling

The converter provides detailed error messages for common scenarios:

  • Null values: "Cannot convert null value to UUID"
  • Invalid string formats: Includes the attempted value in error message
  • Empty strings: "Cannot convert empty string to UUID"
  • Incorrect JSON types: Shows expected vs actual type

Requirements

  • .NET 9.0 or later
  • UUID library
  • Newtonsoft.Json 13.0.3 or later

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. 
.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.

Version Downloads Last updated
1.0.7 71 12/23/2024
1.0.6 77 12/21/2024
1.0.0 76 12/18/2024

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