YamlConverter Class

Converts between YAML tokens and a CLR type.

public abstract class YamlConverter

Constructors

NameDescription
YamlConverter()

YamlConverter()

protected YamlConverter()

No documentation is available.

Methods

NameDescription
CanConvert(Type)Determines whether this converter can handle typeToConvert.
CanPopulate(Type)Determines whether this converter can populate an existing instance instead of creating a replacement.
Populate(YamlReader, Type, object)Populates an existing value instance from YAML.
Read(YamlReader, Type)Reads a value from YAML.
Write(YamlWriter, object?)Writes a value to YAML.

CanConvert(Type)

Determines whether this converter can handle typeToConvert.

public abstract bool CanConvert(Type typeToConvert)

Parameters

typeToConvert Type

Returns

bool

CanPopulate(Type)

YamlConverter.cs

Determines whether this converter can populate an existing instance instead of creating a replacement.

public virtual bool CanPopulate(Type typeToConvert)

Parameters

typeToConvert Type

Returns

bool

Remarks

The default implementation returns false.

Populate(YamlReader, Type, object)

YamlConverter.cs

Populates an existing value instance from YAML.

public virtual object? Populate(YamlReader reader, Type typeToConvert, object existingValue)

Parameters

reader YamlReader
typeToConvert Type
existingValue object

Returns

object?

Remarks

Converters that support population should override both YamlConverter.CanPopulate and this method. The default implementation throws NotSupportedException.

Read(YamlReader, Type)

Reads a value from YAML.

public abstract object? Read(YamlReader reader, Type typeToConvert)

Parameters

reader YamlReader
typeToConvert Type

Returns

object?

Write(YamlWriter, object?)

Writes a value to YAML.

public abstract void Write(YamlWriter writer, object? value)

Parameters

writer YamlWriter
value object?