SyntaxParser Class

Namespace: Meziantou.Framework.Toml.Parsing
Assembly: Meziantou.Framework.Toml.dll
Package: Meziantou.Framework.Toml 1.0.4
Source: SyntaxParser.cs
Available in package assets: net10.0net11.0

Provides a full-fidelity TOML syntax parser producing a round-trippable DocumentSyntax.

public static class SyntaxParser

Methods

Name	Description
Parse(TomlLexer, TomlSerializerOptions, bool)	Parses a TOML payload into a syntax tree.
Parse(TomlLexer, bool)	Parses a TOML payload into a syntax tree.
Parse(TextReader, TomlSerializerOptions, string?, bool)	Parses a TOML payload from a `TextReader` into a syntax tree.
Parse(TextReader, string?, bool)	Parses a TOML payload from a `TextReader` into a syntax tree.
Parse(string, TomlSerializerOptions, string?, bool)	Parses a TOML payload into a syntax tree.
Parse(string, string?, bool)	Parses a TOML payload into a syntax tree.
ParseStrict(TomlLexer, TomlSerializerOptions, bool)	Parses a TOML payload into a syntax tree and throws on any parse/validation error.
ParseStrict(TomlLexer, bool)	Parses a TOML payload into a syntax tree and throws on any parse/validation error.
ParseStrict(TextReader, TomlSerializerOptions, string?, bool)	Parses a TOML payload from a `TextReader` into a syntax tree and throws on any parse/validation error.
ParseStrict(TextReader, string?, bool)	Parses a TOML payload from a `TextReader` into a syntax tree and throws on any parse/validation error.
ParseStrict(string, TomlSerializerOptions, string?, bool)	Parses a TOML payload into a syntax tree and throws on any parse/validation error.
ParseStrict(string, string?, bool)	Parses a TOML payload into a syntax tree and throws on any parse/validation error.

Parse overloads

Parse(TomlLexer, TomlSerializerOptions, bool)

SyntaxParser.cs

Parses a TOML payload into a syntax tree.

public static DocumentSyntax Parse(TomlLexer lexer, TomlSerializerOptions options, bool validate = true)

Parameters

lexer TomlLexer: A TOML lexer positioned before the first token.
options TomlSerializerOptions: Serializer options supplying shared behaviors such as TomlSerializerOptions.MaxDepth.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree, possibly containing diagnostics.

Exceptions

ArgumentNullException: lexer is null.
ArgumentException: lexer is not positioned before its first token.
ArgumentNullException: options is null.

Parse(TomlLexer, bool)

SyntaxParser.cs

Parses a TOML payload into a syntax tree.

public static DocumentSyntax Parse(TomlLexer lexer, bool validate = true)

Parameters

lexer TomlLexer: A TOML lexer positioned before the first token.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree, possibly containing diagnostics.

Exceptions

ArgumentNullException: lexer is null.
ArgumentException: lexer is not positioned before its first token.

Parse(TextReader, TomlSerializerOptions, string?, bool)

SyntaxParser.cs

Parses a TOML payload from a TextReader into a syntax tree.

public static DocumentSyntax Parse(TextReader reader, TomlSerializerOptions options, string? sourceName = null, bool validate = true)

Parameters

reader TextReader: The text reader.
options TomlSerializerOptions: Serializer options supplying shared behaviors such as TomlSerializerOptions.MaxDepth.
sourceName string?: An optional source name used in diagnostics.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree, possibly containing diagnostics.

Exceptions

ArgumentNullException: reader is null.
ArgumentNullException: options is null.

Parse(TextReader, string?, bool)

SyntaxParser.cs

Parses a TOML payload from a TextReader into a syntax tree.

public static DocumentSyntax Parse(TextReader reader, string? sourceName = null, bool validate = true)

Parameters

reader TextReader: The text reader.
sourceName string?: An optional source name used in diagnostics.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree, possibly containing diagnostics.

Exceptions

ArgumentNullException: reader is null.

Parse(string, TomlSerializerOptions, string?, bool)

SyntaxParser.cs

Parses a TOML payload into a syntax tree.

public static DocumentSyntax Parse(string toml, TomlSerializerOptions options, string? sourceName = null, bool validate = true)

Parameters

toml string: The TOML payload.
options TomlSerializerOptions: Serializer options supplying shared behaviors such as TomlSerializerOptions.MaxDepth.
sourceName string?: An optional source name used in diagnostics.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree, possibly containing diagnostics.

Exceptions

ArgumentNullException: toml is null.
ArgumentNullException: options is null.

Parse(string, string?, bool)

SyntaxParser.cs

Parses a TOML payload into a syntax tree.

public static DocumentSyntax Parse(string toml, string? sourceName = null, bool validate = true)

Parameters

toml string: The TOML payload.
sourceName string?: An optional source name used in diagnostics.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree, possibly containing diagnostics.

Exceptions

ArgumentNullException: toml is null.

ParseStrict overloads

ParseStrict(TomlLexer, TomlSerializerOptions, bool)

SyntaxParser.cs

Parses a TOML payload into a syntax tree and throws on any parse/validation error.

public static DocumentSyntax ParseStrict(TomlLexer lexer, TomlSerializerOptions options, bool validate = true)

Parameters

lexer TomlLexer: A TOML lexer positioned before the first token.
options TomlSerializerOptions: Serializer options supplying shared behaviors such as TomlSerializerOptions.MaxDepth.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree.

Exceptions

ArgumentNullException: lexer is null.
ArgumentException: lexer is not positioned before its first token.
ArgumentNullException: options is null.
TomlException: The TOML payload is invalid.

ParseStrict(TomlLexer, bool)

SyntaxParser.cs

Parses a TOML payload into a syntax tree and throws on any parse/validation error.

public static DocumentSyntax ParseStrict(TomlLexer lexer, bool validate = true)

Parameters

lexer TomlLexer: A TOML lexer positioned before the first token.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree.

Exceptions

ArgumentNullException: lexer is null.
ArgumentException: lexer is not positioned before its first token.
TomlException: The TOML payload is invalid.

ParseStrict(TextReader, TomlSerializerOptions, string?, bool)

SyntaxParser.cs

Parses a TOML payload from a TextReader into a syntax tree and throws on any parse/validation error.

public static DocumentSyntax ParseStrict(TextReader reader, TomlSerializerOptions options, string? sourceName = null, bool validate = true)

Parameters

reader TextReader: The text reader.
options TomlSerializerOptions: Serializer options supplying shared behaviors such as TomlSerializerOptions.MaxDepth.
sourceName string?: An optional source name used in diagnostics.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree.

Exceptions

ArgumentNullException: reader is null.
ArgumentNullException: options is null.
TomlException: The TOML payload is invalid.

ParseStrict(TextReader, string?, bool)

SyntaxParser.cs

Parses a TOML payload from a TextReader into a syntax tree and throws on any parse/validation error.

public static DocumentSyntax ParseStrict(TextReader reader, string? sourceName = null, bool validate = true)

Parameters

reader TextReader: The text reader.
sourceName string?: An optional source name used in diagnostics.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree.

Exceptions

ArgumentNullException: reader is null.
TomlException: The TOML payload is invalid.

ParseStrict(string, TomlSerializerOptions, string?, bool)

SyntaxParser.cs

Parses a TOML payload into a syntax tree and throws on any parse/validation error.

public static DocumentSyntax ParseStrict(string toml, TomlSerializerOptions options, string? sourceName = null, bool validate = true)

Parameters

toml string: The TOML payload.
options TomlSerializerOptions: Serializer options supplying shared behaviors such as TomlSerializerOptions.MaxDepth.
sourceName string?: An optional source name used in diagnostics.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree.

Exceptions

ArgumentNullException: toml is null.
ArgumentNullException: options is null.
TomlException: The TOML payload is invalid.

ParseStrict(string, string?, bool)

SyntaxParser.cs

Parses a TOML payload into a syntax tree and throws on any parse/validation error.

public static DocumentSyntax ParseStrict(string toml, string? sourceName = null, bool validate = true)

Parameters

toml string: The TOML payload.
sourceName string?: An optional source name used in diagnostics.
validate bool: When true, runs semantic validation after parsing.

Returns

DocumentSyntax The parsed syntax tree.

Exceptions

ArgumentNullException: toml is null.
TomlException: The TOML payload is invalid.