Parser0.30.2

Overview
Properties
Methods

class Parser

A YAML parser.

Known subtypes in package:
Known usages in package:
All versions:

YAML values are mapped to Pkl values as follows:

YAML type	Pkl type
!!null	`Null`
!!bool	`Boolean`
!!int	`Int`
!!float	`Float`
!!string	`String`
!!seq	`Listing`
!!set	`Listing`
!!map	`Dynamic` or `Mapping` depending on `Parser.useMapping`
!!binary	`Bytes`
!!timestamp	`String`

The element order of YAML sequences, sets, and mappings is maintained. YAML binary values are mapped to their original (base64) string representation. YAML timestamp values are mapped to their original string representation.

If the parser encounters a YAML type not listed above, it fails with an error.

Known limitations:

Merge keys are not supported.
Comments are not retained.

Properties

link
mode: "compat"|"1.1"|"1.2"

The YAML version used by producers of the parsed documents.
- "compat" - YAML 1.1 or 1.2 (default)
- "1.1" - YAML 1.1
- "1.2" - YAML 1.2 (Core schema)
link

useMapping: Boolean

Determines what the parser produces when parsing YAML !!map types.

If true, they turn into a Mapping. Otherwise, they turn into a Dynamic.

If useMapping is false, map properties named default will be shadowed by the built-in Dynamic.default property.
link

converters: Mapping<(Class|String(!isEmpty)), (unknown) -> unknown>

Value converters to apply to parsed values.

For further information see PcfRenderer.converters.
link

maxCollectionAliases: Int32(isPositive)

The maximum number of aliases for collection nodes.

Limiting the number of collection aliases prevents billion laughs attacks.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function

parse(source: Resource|String): Value

Parses the single YAML document contained in source.

Throws if an error occurs during parsing, or if source contains multiple YAML documents.

If source is a Resource, the resource URI is included in parse error messages.
link

function

parseAll(source: Resource|String): List<Value>

Parses all YAML documents contained in source.

Throws if an error occurs during parsing.

If source is a Resource, the resource URI is included in parse error messages.