Class ExceptionConverter

Namespace

Codebelt.Extensions.YamlDotNet.Converters

Assembly

Codebelt.Extensions.YamlDotNet.dll

Converts an System.Exception to YAML.

public class ExceptionConverter : YamlConverter<Exception>, IYamlTypeConverter

Inheritance

Object

YamlConverter

YamlConverter<Exception>

ExceptionConverter

Implements

IYamlTypeConverter

Inherited Members

YamlConverter.Formatter

YamlConverter.IYamlTypeConverter.Accepts(Type)

YamlConverter.IYamlTypeConverter.ReadYaml(IParser, Type, ObjectDeserializer)

YamlConverter.IYamlTypeConverter.WriteYaml(IEmitter, Object, Type, ObjectSerializer)

Constructors

ExceptionConverter(Boolean, Boolean)

Initializes a new instance of the ExceptionConverter class.

public ExceptionConverter(bool includeStackTrace = false, bool includeData = false)

Parameters

includeStackTrace Boolean

A value that indicates if the stack of an exception is included in the converted result.

includeData Boolean

A value that indicates if the data of an exception is included in the converted result.

Properties

IncludeData

Gets a value indicating whether the data of an exception is included in the converted result.

public bool IncludeData { get; }

Property Value

Boolean

true if the data of an exception is included in the converted result; otherwise, false.

IncludeStackTrace

Gets a value indicating whether the stack of an exception is included in the converted result.

public bool IncludeStackTrace { get; }

Property Value

Boolean

true if the stack of an exception is included in the converted result; otherwise, false.

Methods

CanConvert(Type)

Determines whether this instance can convert the specified object type.

public override bool CanConvert(Type typeToConvert)

Parameters

typeToConvert Type

Type of the object.

Returns

Boolean

true if this instance can convert the specified object type; otherwise, false.

ReadYaml(IParser, Type)

Reads and converts the YAML to System.Exception.

public override Exception ReadYaml(IParser reader, Type typeToConvert)

Parameters

reader IParser

The reader to read from.

typeToConvert Type

The type to convert.

Returns

Exception

The converted value.

Exceptions

System.NotImplementedException

WriteYaml(IEmitter, Exception)

Writes a specified value as YAML.

public override void WriteYaml(IEmitter writer, Exception value)

Parameters

writer IEmitter

The writer to write to.

value Exception

The value to convert to YAML.

See Also

YamlConverter<T>