YamlDocument.EnumerateEvents Method

Definition

Namespace: Corvus.Text.Json.Yaml
Assembly: Corvus.Text.Json.dll

Method	Description
EnumerateEvents(ReadOnlySpan<byte>, YamlEventCallback, YamlReaderOptions)	Enumerates the YAML parse events from UTF-8 YAML bytes, invoking the specified callback for each event.
EnumerateEvents(string, YamlEventCallback, YamlReaderOptions)	Enumerates the YAML parse events from a YAML string, invoking the specified callback for each event.

Enumerates the YAML parse events from UTF-8 YAML bytes, invoking the specified callback for each event.

public static bool EnumerateEvents(ReadOnlySpan<byte> utf8Yaml, YamlEventCallback callback, YamlReaderOptions options)

Name	Type	Description
`utf8Yaml`	`ReadOnlySpan<byte>`	The UTF-8 encoded YAML bytes.
`callback`	`YamlEventCallback`	A callback invoked for each YAML event. Return `true` to continue parsing or `false` to stop early. The `YamlEvent` and its spans are only valid for the duration of the callback.
`options`	`YamlReaderOptions`	Optional YAML reader options. (optional)

true if parsing completed normally; false if the callback returned false to stop early.

Exception	Description
`YamlException`	The YAML content is invalid.

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

Enumerates the YAML parse events from a YAML string, invoking the specified callback for each event.

public static bool EnumerateEvents(string yaml, YamlEventCallback callback, YamlReaderOptions options)

Name	Type	Description
`yaml`	`string`	The YAML content as a string.
`callback`	`YamlEventCallback`	A callback invoked for each YAML event. Return `true` to continue parsing or `false` to stop early. The `YamlEvent` and its spans are only valid for the duration of the callback.
`options`	`YamlReaderOptions`	Optional YAML reader options. (optional)

true if parsing completed normally; false if the callback returned false to stop early.

Exception	Description
`YamlException`	The YAML content is invalid.

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

The source for this content can be found on GitHub, where you can also create and review issues and pull requests.