YamlSerializerOptions Class

Definition

Namespace

Bodu.Text.Yaml

Assembly

Bodu.Text.Yaml.dll

Package

Bodu.Text.Yaml 1.0.0

Source

SerializerOptions.Resolution.cs

Provides options that configure YamlSerializer, in the manner of JsonSerializerOptions.

public sealed class YamlSerializerOptions

Inheritance

object

YamlSerializerOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

An options instance becomes read-only the first time it is used to serialize or deserialize, or when MakeReadOnly() is called. After that point its settable properties throw InvalidOperationException, which guarantees deterministic behavior when the same instance is shared across threads.

Constructors

YamlSerializerOptions()

Initializes a new instance of the YamlSerializerOptions class.

public YamlSerializerOptions()

YamlSerializerOptions(YamlSerializerDefaults)

Initializes a new instance of the YamlSerializerOptions class with a base set of defaults appropriate for the specified usage scenario.

public YamlSerializerOptions(YamlSerializerDefaults defaults)

Parameters

defaults YamlSerializerDefaults

The base defaults to apply.

Remarks

Web selects camel-case property naming and case-insensitive property-name matching; General leaves the defaults unchanged.

Exceptions

ArgumentOutOfRangeException

Thrown when defaults is not a defined YamlSerializerDefaults value.

Properties

Converters

Gets the list of custom converters consulted before the built-in handling.

public IList<YamlConverter> Converters { get; }

Property Value

IList<YamlConverter>

The converter collection.

DefaultIgnoreCondition

Gets or sets the serializer-wide default condition under which a member is omitted when writing, applied to every member that does not carry its own IgnoreCondition through an attribute.

public IgnoreCondition DefaultIgnoreCondition { get; set; }

Property Value

IgnoreCondition

The default ignore condition; Never by default.

Exceptions

InvalidOperationException

The options instance is read-only.

ArgumentOutOfRangeException

Thrown when the value is undefined, or when it is Always, which is not a valid serializer-wide default.

DuplicateKeyBehavior

Gets or sets the policy applied when a mapping declares the same key more than once during deserialization.

public YamlDuplicateKeyBehavior DuplicateKeyBehavior { get; set; }

Property Value

YamlDuplicateKeyBehavior

The duplicate-key policy; the default is Throw.

Exceptions

InvalidOperationException

The options instance is read-only.

IncludeFields

Gets or sets a value indicating whether public fields are serialized in addition to properties.

public bool IncludeFields { get; set; }

Property Value

bool

true to include public fields; otherwise false.

Exceptions

InvalidOperationException

The options instance is read-only.

IsReadOnly

Gets a value indicating whether the options have become read-only.

public bool IsReadOnly { get; }

Property Value

bool

true once the options have been used or frozen; otherwise false.

MaxDepth

Gets or sets the maximum depth allowed when serializing an object graph and when parsing during deserialization.

public int MaxDepth { get; set; }

Property Value

int

The maximum depth. A value of zero or less selects the default of 64.

Exceptions

InvalidOperationException

The options instance is read-only.

MergeKeyBehavior

Gets or sets the policy applied to the YAML merge key (<<) during deserialization.

public YamlMergeKeyBehavior MergeKeyBehavior { get; set; }

Property Value

YamlMergeKeyBehavior

The merge-key policy; the default is Expand.

Exceptions

InvalidOperationException

The options instance is read-only.

NumberHandling

Gets or sets the policy applied when coercing numeric scalars to integral targets.

public YamlNumberHandling NumberHandling { get; set; }

Property Value

YamlNumberHandling

The number-handling policy; the default is Strict.

Exceptions

InvalidOperationException

The options instance is read-only.

PreferredObjectCreationHandling

Gets or sets the serializer-wide default for whether a member's value is replaced with a freshly created instance or populated into the value the member already holds during deserialization.

public ObjectCreationHandling PreferredObjectCreationHandling { get; set; }

Property Value

ObjectCreationHandling

The preferred object-creation handling; the default is Replace.

Exceptions

InvalidOperationException

The options instance is read-only.

PropertyNameCaseInsensitive

Gets or sets a value indicating whether YAML keys are matched to members case-insensitively.

public bool PropertyNameCaseInsensitive { get; set; }

Property Value

bool

true to match keys case-insensitively; otherwise false.

Exceptions

InvalidOperationException

The options instance is read-only.

PropertyNamingPolicy

Gets or sets the policy used to convert member names to YAML keys.

public NamingPolicy? PropertyNamingPolicy { get; set; }

Property Value

NamingPolicy

The naming policy, or null to use member names verbatim.

Exceptions

InvalidOperationException

The options instance is read-only.

SpecVersion

Gets or sets the YAML specification version applied when parsing during deserialization.

public YamlSpecVersion SpecVersion { get; set; }

Property Value

YamlSpecVersion

The specification version; the default is V1_2.

Exceptions

InvalidOperationException

The options instance is read-only.

UnmappedMemberHandling

Gets or sets the policy applied to a YAML key that does not map to any member of the target type.

public UnmappedMemberHandling UnmappedMemberHandling { get; set; }

Property Value

UnmappedMemberHandling

The unmapped-member policy; the default is Skip.

Exceptions

InvalidOperationException

The options instance is read-only.

WriteEnumsAsStrings

Gets or sets a value indicating whether enumerations are written as their string names.

public bool WriteEnumsAsStrings { get; set; }

Property Value

bool

true to write enum names; false to write their numeric values. The default is true.

Exceptions

InvalidOperationException

The options instance is read-only.

Methods

GetConverter(Type)

Resolves the converter that handles the specified type, applying the type-level converter attribute, the registered converters, and finally the built-in converters, in that order.

[RequiresUnreferencedCode("Reflection-based YAML serialization may require types that trimming cannot statically determine.")]
public YamlConverter GetConverter(Type typeToConvert)

Parameters

typeToConvert Type

The type to resolve a converter for.

Returns

YamlConverter

The concrete converter for the type.

Exceptions

ArgumentNullException

Thrown when typeToConvert is null.

NotSupportedException

Thrown when no converter handles the type.

MakeReadOnly()

Freezes the options so their settings can no longer change, capturing the converter list. Called automatically before the first serialization or deserialization.

public void MakeReadOnly()

Applies to

Product	Versions
.NET	8, 10