OneYaml.Compat.YamlDotNet
1.2.1
dotnet add package OneYaml.Compat.YamlDotNet --version 1.2.1
NuGet\Install-Package OneYaml.Compat.YamlDotNet -Version 1.2.1
<PackageReference Include="OneYaml.Compat.YamlDotNet" Version="1.2.1" />
<PackageVersion Include="OneYaml.Compat.YamlDotNet" Version="1.2.1" />
<PackageReference Include="OneYaml.Compat.YamlDotNet" />
paket add OneYaml.Compat.YamlDotNet --version 1.2.1
#r "nuget: OneYaml.Compat.YamlDotNet, 1.2.1"
#:package OneYaml.Compat.YamlDotNet@1.2.1
#addin nuget:?package=OneYaml.Compat.YamlDotNet&version=1.2.1
#tool nuget:?package=OneYaml.Compat.YamlDotNet&version=1.2.1
OneYaml.Compat.YamlDotNet
A compatibility adapter for code written against YamlDotNet 18, running on OneYaml.
It covers a subset of YamlDotNet's API, tested against YamlDotNet 18.1.0; code that takes or returns YamlDotNet types from other libraries still needs YamlDotNet itself. Every difference and every part not covered is listed in the compatibility notes.
It provides the YamlDotNet serializer builders (DeserializerBuilder, SerializerBuilder, naming conventions, YamlMember, IYamlTypeConverter) and the representation model (YamlStream, YamlMappingNode and the other nodes) under the OneYaml.Compat.YamlDotNet namespaces. For the API the migration guide lists, changing the package and the using lines keeps your call sites:
using YamlDotNet.Serialization; -> using OneYaml.Compat.YamlDotNet.Serialization;
using YamlDotNet.RepresentationModel; -> using OneYaml.Compat.YamlDotNet.RepresentationModel;
using YamlDotNet.Core; -> using OneYaml.Compat.YamlDotNet.Core;
It reads the YAML 1.1 forms YamlDotNet documents for typed targets, and it does not copy YamlDotNet's defects. Some behaviour differs on purpose, and some of YamlDotNet's API is not provided; both are listed with a repro for each. It reads with OneYaml's default limits. DeserializerBuilder.WithLimits, and limits overloads of YamlStream.Load and the Parser constructor, are additions that YamlDotNet does not have: pass them OneYaml.YamlLimits.Untrusted for input you do not control. An option the adapter cannot follow, such as EnsureRoundtrip, throws NotSupportedException instead of being ignored.
- Migrating from YamlDotNet: the swap, what to check after it, and the move to the
OneYamlAPI - Every difference from YamlDotNet
- OneYaml, the library underneath
New code should use the OneYaml package. Report problems at GitHub issues. Licensed under MIT or Apache-2.0, at your option.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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 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 is compatible. 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. |
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.