toml library
This library exports the entire public interface of the toml.dart package.
Classes
- TomlArray
- AST node that represents a TOML array value.
- TomlArrayTable
- A TOML expression AST node that represents the header of an entry of an array of tables.
- TomlAstBuilder
- A builder for various TOML AST nodes.
- TomlBasicString
- AST node that represents basic TOML strings.
- TomlBoolean
- AST node that represents a boolean TOML value.
- TomlDateTime
- Base class of AST nodes that represents TOML date, time and date-time values.
-
TomlDateTimeVisitor<
R> - Interface for visitors of TomlStrings.
- TomlDocument
- Abstract syntax tree for a TOML document.
- TomlEncodableKey
- Interface for an object which can be encoded as a TOML key.
- TomlEncodableValue
- Interface for an object which can be encoded as a TOML value or table.
- TomlExpression
- Base class of all TOML expression nodes.
-
TomlExpressionVisitor<
R> - Interface for visitors of TomlExpressions.
- TomlFloat
- AST node that represents a TOML floating point number.
- TomlFullDate
- A date without time and time-zone offset that is used for the internal representation of TOML date and date-time values.
- TomlInlineTable
- AST node that represents a TOML inline table.
- TomlInteger
- AST node that represents a TOML integer.
- TomlIntegerFormat
- A TOML integer can be formatted with one of four bases.
- TomlKey
- AST node that represents a dot separated list of TomlSimpleKeys.
- TomlKeyValuePair
- A TOML expression AST node that represents a key/value pair.
- TomlLiteralString
- AST node that represents literal TOML strings.
- TomlLocalDate
- AST node that represents a TOML local date value.
- TomlLocalDateTime
- AST node that represents a TOML local date-time value.
- TomlLocalTime
- AST node that represents a TOML local time value.
- TomlMapBuilder
- A visitor for TomlExpressions that builds a Map from a TOML document.
- TomlMultilineBasicString
- AST node that represents multiline basic TOML strings.
- TomlMultilineLiteralString
- AST node that represents multiline literal TOML strings.
- TomlMultilineString
- Base class for AST nodes that represent multiline TOML strings.
- TomlNode
- Base class of all TOML AST nodes.
- TomlOffsetDateTime
- AST node that represents a TOML offset date-time value.
- TomlPartialTime
- A time without time-zone offset that is used for the internal representation of TOML time and date-time values.
- TomlPrettyPrinter
- A visitor for TOML AST nodes that converts them to a TOML formatted string.
- TomlQuotedKey
- AST node that represents a quoted key.
- TomlSimpleKey
- Base class of all AST nodes that represent simple TOML keys (i.e. non-dotted keys).
-
TomlSimpleKeyVisitor<
R> - Interface for visitors of TomlSimpleKeys.
- TomlSinglelineString
- Base class for AST nodes that represent non-multiline TOML strings (i.e., literal and basic strings).
- TomlStandardTable
- A TOML expression AST node that represents the header of a standard TOML table.
- TomlString
- Base class for AST nodes that represent a TOML strings.
-
TomlStringVisitor<
R> - Interface for visitors of TomlStrings.
- TomlTable
- Base class of all TOML table header expressions.
- TomlTimeZoneOffset
- A time-zone offset that is used for the representation of TOML date-time values.
- TomlUnquotedKey
- AST node that represents an unquoted key.
- TomlValue
- Base class for AST nodes that represent TOML values.
- TomlValueBuilder
- A visitor for TomlValues that builds Dart values from their internal representations.
-
TomlValueVisitor<
R> - Interface for visitors of TomlValues.
-
TomlVisitor<
R> - Interface for visitors of TomlNodes.
Enums
- TomlStringType
- The four types of TOML strings.
- TomlTableType
- The two types of TOML tables that can be declared by a table header expression.
- TomlType
- The possible types of TomlValues.
Mixins
-
TomlDateTimeVisitorMixin<
R> - Mixin that adds a visitDateTime method to classes implementing TomlDateTimeVisitor that automatically selects the appropriate visitor method using TomlDateTime.acceptDateTimeVisitor.
-
TomlExpressionVisitorMixin<
R> - Mixin that adds a visitExpression method to classes implementing TomlExpressionVisitor that automatically selects the appropriate visitor method using TomlExpression.acceptExpressionVisitor.
-
TomlSimpleKeyVisitorMixin<
R> - Mixin that adds a visitSimpleKey method to classes implementing TomlSimpleKeyVisitor that automatically selects the appropriate visitor method using TomlSimpleKey.acceptSimpleKeyVisitor.
-
TomlStringVisitorMixin<
R> - Mixin that adds a visitString method to classes implementing TomlStringVisitor that automatically selects the appropriate visitor method using TomlString.acceptStringVisitor.
-
TomlValueVisitorMixin<
R> - Mixin that adds a visitValue method to classes implementing TomlValueVisitor that automatically selects the appropriate visitor method using TomlValue.acceptValueVisitor.
-
TomlVisitorMixin<
R> - Mixin that adds a visitExpression method to classes implementing TomlExpressionVisitor that automatically selects the appropriate visitor method using TomlValue.acceptVisitor.
Extensions
-
TomlParserExceptionExtension
on Result<
T> -
An extension method on parser
Results that adds a valueOrTomlException method that behaves likeResult.valuebut throws a TomlParserException instead of aParserExceptionwhen the result is aFailure.
Properties
- tomlComment → Parser
-
Parser for a TOML comment.
final
-
tomlNewline
→ Parser<
String> -
Parser for a TOML newline.
final
- tomlNewlinePattern → RegExp
-
A regular expression for tomlNewline.
final
-
tomlNonAscii
→ Parser<
String> -
Parser for non-ASCII characters that are allowed in TOML comments and
literal strings.
final
-
tomlNonEol
→ Parser<
String> -
Parser for non-EOL characters that are allowed in TOML comments.
final
-
tomlWhitespace
→ Parser<
String> -
Parser for TOML whitespace.
final
-
tomlWhitespaceChar
→ Parser<
String> -
Parser for a single TOML whitespace character.
wschar = %x20 ; Space
wschar =/ %x09 ; Horizontal tab
final
- tomlWhitespaceCommentNewline → Parser
-
Parser for arbitrarily many tomlWhitespaceChars, tomlNewlines and
tomlComments.
final
Functions
-
tomlBinDigit(
[String message = 'binary digit expected']) → Parser< String> - Parser for a binary digits.
-
tomlHexDigit(
[String message = 'hexadecimal digit expected']) → Parser< String> - Parser for hexadecimal digits.
-
tomlOctDigit(
[String message = 'octal digit expected']) → Parser< String> - Parser for a octal digits.
Exceptions / Errors
- TomlException
- Base class for all TOML related exceptions.
- TomlInvalidDateTimeException
- An exception which is thrown when the parser encounters an invalid local time, local date, local date-time or offset date-time.
- TomlInvalidEscapeSequenceException
- An exception which is thrown when the parser encounters an unspecified escape sequence.
- TomlNotATableException
- An exception which is thrown when the parent element of a table is not a table or array of tables.
- TomlParserException
- An exception which is thrown when there is an error while parsing a TOML document or value.
- TomlRedefinitionException
- An exception which is thrown when a table or key is defined more than once.
- TomlUnknownKeyTypeException
- An error which is thrown when an object cannot be encoded as a key.
- TomlUnknownValueTypeException
- An error which is thrown when an object cannot be encoded as a value.