Tomlyn is a TOML parser, validator and authoring library for .NET Framework and .NET Core.
A config file format for humans. TOML aims to be a minimal configuration file format that's easy to read due to obvious semantics. TOML is designed to map unambiguously to a hash table. TOML should be easy to parse into data structures in a wide variety of languages.
- See the official website https://toml.io/en/ for more details.
- Example and specifications are available at TOML v1.0.0
- Very fast parser, GC friendly.
- Compatible with the latest TOML v1.0.0 specs.
- Allow to map a TOML string to a default runtime model via
Toml.ToModel(string)
- Allow to map a TOML string to a custom runtime model via
Toml.ToModel<T>(string)
- Very convenient for loading custom configurations for example.
- Allow to generate a TOML string from a runtime model via
string Toml.FromModel(object)
- Preserve comments, by default with the default runtime model, or by implementing the
ITomlMetadataProvider
.
- Preserve comments, by default with the default runtime model, or by implementing the
- Allow to parse to a
DocumentSyntax
viaToml.Parse(string)
.- Preserve all spaces, new line, comments but also invalid characters/tokens.
- Can roundtrip to text with exact representation.
- Provides a validator with the
Toml.Validate
method. - Supports for .NET Standard 2.0 and provides an API with nullable annotations.
See the documentation for more details.
Tomlyn is delivered as a NuGet Package.
var toml = @"global = ""this is a string""
# This is a comment of a table
[my_table]
key = 1 # Comment a key
value = true
list = [4, 5, 6]
";
// Parse the TOML string to the default runtime model `TomlTable`
var model = Toml.ToModel(toml);
// Fetch the string
var global = (string)model["global"]!;
// Prints: found global = "this is a string"
Console.WriteLine($"found global = \"{global}\"");
// Generates a TOML string from the model
var tomlOut = Toml.FromModel(model);
// Output the generated TOML
Console.WriteLine(tomlOut);
This will print the original TOML by preserving most the comments:
global = "this is a string"
# This is a comment of a table
[my_table]
key = 1 # Comment a key
value = true
list = [4, 5, 6]
NOTICE: By default, when mapping to a custom model, Tomlyn is using the PascalToSnakeCase naming convention (e.g
ThisIsFine
tothis_is_fine
). This behavior can be changed by overriding theTomlModelOptions.ConvertPropertyName
delegate.
This software is released under the BSD-Clause 2 license.
Modified version of the logo Thor
by Mike Rowe from the Noun Project (Creative Commons)
Alexandre Mutel aka xoofx.