KsWare.YamlDotNet 13.0.6

KsWare.YamlDotNet

KsWare.YamlDotNet is a fork of YamlDotNet with the aim of improving expandability and usability.

YamlDotNet is a YAML library for netstandard and other .NET runtimes.

YamlDotNet provides low level parsing and emitting of YAML as well as a high level object model similar to XmlDocument. A serialization library is also included that allows to read and write objects from and to YAML streams.

Features

ALPHA Version. All features are preliminary und subject to change.

• supported TargetVersions: net60;netstandard2.0;netstandard2.1;net48;(net70?)
  • unsupported: net35;net40;net45;net47;
• Feature #1: De-/SerializerBuilder in Emitter/Parser
• Feature #2: YamlConverterAttribute

The current build is based on YamlDotNet 13.0.2.

The API remains fully compatible with YamlDotNet.
The YamlDotNet package can be easily replaced by KsWare.YamlDotNet

Feature #1: De-/SerializerBuilder in Emitter/Parser

• new class SerializerBuilderData
• new API IEmitter.SerializerBuilderData
• new class DeserializerBuilderData
• new API IParser.DeserializerBuilderData

Now you can get all information about the SerializerBuilder (and Serializer) while writing a IYamlConverter.

public class MyObjectConverter : IYamlTypeConverter {

    public object? ReadYaml(IParser parser, Type type) {
        var deserializer = parser.DeserializerBuilderData.Build();
        ...
    }

    public void WriteYaml(IEmitter emitter, object value, Type type) {
		var serializer = emitter.SerializerBuilderData.Build();
        var dvh = emitter.SerializerBuilderData.DefaultValuesHandlingConfiguration;
		var nc = emitter.SerializerBuilderData.NamingConvention;
        ...
    }
}

Feature #2: YamlConverterAttribute

• new class YamlConverterAttribute

Now you can specfify a converter for a property. (like in JsonConverter) without to configure a special serializer

class MyClass {
    [YamlConverter(typeof(MyObjectConverter)]
    public object MyProperty {get;set;}
}

Drawbacks

Due to lack of resources this librray does not support all target frameworks of the original and application testing is done for the KsWare development environment only.

Credits

The code is mainly based on the work of Antoine Aubry and contributors, who published the original material at https://github.com/aaubry/YamlDotNet. Thanks for the great work!

If you find my additional feature useful, feel free to use it in your projects or suggest it to the original project.