KeyValueSerializer 1.0.1

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher. 
dotnet add package KeyValueSerializer --version 1.0.1
                    


                    

                
NuGet\Install-Package KeyValueSerializer -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="KeyValueSerializer" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="KeyValueSerializer" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="KeyValueSerializer" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add KeyValueSerializer --version 1.0.1
                    


                    

                
#r "nuget: KeyValueSerializer, 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. 
#:package KeyValueSerializer@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=KeyValueSerializer&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=KeyValueSerializer&version=1.0.1
                    


                            Install as a Cake Tool

Key Value Serializer

About

This project is a performance focused .NET Library for serializing key value files. These files are commonly found when working with configuring video games or other applications that have human readable setting files that allow users to change the configuration through a text file.

Mission

Creating a high-performance and low allocation key value UTF8 serializer that can be customized without code changes.

How to Use

Use the static class KeyValueSerializer with either the DeserializeAsync<T> or Serialize method for which task you want to do.

using var fileStream = File.Open("mypath", FileMode.Open);
TestSerial myNewObject = await KeyValueSerializer.DeserializeAsync<TestSerial>(fileStream);

var myNewObject = new TestSerial();
using var fileStream = File.Open("mypath", FileMode.OpenOrCreate);
KeyValueSerializer.Serialize(fileStream, myNewObject);

If your type property has a name that differs from the file make sure to annotate the property using KeyFileName attribute.

[KeyFileName("strings")]
public string[]? Strings { get; set; }

Why

For my personal projects I needed a way to serialize key value files with support for values that could span multiple lines and would deserialize into static objects.

Product Compatible and additional computed target framework versions.
.NET 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 was computed.  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 was computed.  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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows 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.1 254 3/31/2023
1.0.0 267 3/27/2023