Meziantou.FrameworkYamlPolymorphismOptions Class
Configures polymorphic serialization behavior.
public sealed class YamlPolymorphismOptionsConstructors
| Name | Description |
|---|---|
| YamlPolymorphismOptions() |
YamlPolymorphismOptions()
YamlPolymorphismOptions.cspublic YamlPolymorphismOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| DerivedTypeMappings | Gets runtime-registered derived type mappings, keyed by base type. |
| DiscriminatorStyle | Gets or sets how type discriminators are represented. |
| InferClosedTypePolymorphism | Gets or sets a value indicating whether derived type registrations are inferred from the compiler-provided metadata of a closed type hierarchy. |
| TypeDiscriminatorPropertyName | Gets or sets the property name used for discriminator-based polymorphism. |
| UnknownDerivedTypeHandling | Gets or sets behavior when an unknown derived type discriminator is encountered. |
DerivedTypeMappings
YamlPolymorphismOptions.csGets runtime-registered derived type mappings, keyed by base type.
public IDictionary<Type, IList<YamlDerivedType>> DerivedTypeMappings { get; }Property value
IDictionary<Type, IList<YamlDerivedType>>
Remarks
Entries registered here are merged with the registrations declared by YamlDerivedTypeAttribute, which take precedence when the same discriminator, tag, or type is registered in both. Registering the same derived type, discriminator, or tag more than once for a base type within the mappings is an error.
This enables cross-project polymorphism where the base type and derived types live in different assemblies (e.g., clean architecture, plugin systems).
The mappings can only be changed until the instance is assigned to YamlSerializerOptions.PolymorphismOptions. The mappings are copied at that point, and the instance becomes read-only: a later change throws NotSupportedException, so it cannot affect options that are already in use.
DiscriminatorStyle
YamlPolymorphismOptions.csGets or sets how type discriminators are represented.
public YamlTypeDiscriminatorStyle DiscriminatorStyle { get; init; }Property value
Exceptions
InferClosedTypePolymorphism
YamlPolymorphismOptions.csGets or sets a value indicating whether derived type registrations are inferred from the compiler-provided metadata of a closed type hierarchy.
public bool InferClosedTypePolymorphism { get; init; }Property value
Remarks
Each inferred derived type uses its name, without the generic arity suffix, as its discriminator. Inference is skipped for a type that declares explicit registrations, either with YamlDerivedTypeAttribute or in YamlPolymorphismOptions.DerivedTypeMappings.
YamlPolymorphicAttribute.InferClosedTypePolymorphism overrides this value for the type it is applied to.
TypeDiscriminatorPropertyName
YamlPolymorphismOptions.csGets or sets the property name used for discriminator-based polymorphism.
public string TypeDiscriminatorPropertyName { get; init; }UnknownDerivedTypeHandling
YamlPolymorphismOptions.csGets or sets behavior when an unknown derived type discriminator is encountered.
public YamlUnknownDerivedTypeHandling UnknownDerivedTypeHandling { get; init; }