1. Home
2. Docs
3. Serialization
4. Errors and diagnostics

SharpYaml throws YamlException for parsing and (most) serialization failures.

Parsing context

When possible, exceptions include:

• source name (for example a file path) via YamlSerializerOptions.SourceName
• line and column
• a span (start/end location)

These are available through YamlException.SourceName, YamlException.Start, and YamlException.End.

var options = new YamlSerializerOptions
{
    SourceName = "appsettings.yaml",
};

var model = YamlSerializer.Deserialize<MyConfig>(": invalid", options);

TryDeserialize

If you prefer failure-tolerant parsing without exceptions, use YamlSerializer.TryDeserialize(...):

if (!YamlSerializer.TryDeserialize<MyConfig>(yaml, out var model, options))
{
    // Invalid YAML or incompatible payload.
}

Required members

If a required member is missing (for example [YamlRequired] or [JsonRequired]), deserialization throws YamlException.