SnakeYAML Engine KMP/it.krzeminski.snakeyaml.engine.kmp.api/LoadSettings

LoadSettings

class LoadSettings(val label: String = "reader", val tagConstructors: Map<Tag, ConstructNode> = emptyMap(), val defaultList: LoadSettings.CollectionProvider<MutableList<Any?>> = CollectionProvider { initialCapacity: Int -> ArrayList(initialCapacity) }, val defaultSet: LoadSettings.CollectionProvider<MutableSet<Any?>> = CollectionProvider { initialCapacity: Int -> LinkedHashSet(initialCapacity) }, val defaultMap: LoadSettings.CollectionProvider<MutableMap<Any?, Any?>> = CollectionProvider { initialCapacity: Int -> LinkedHashMap(initialCapacity) }, val versionFunction: LoadSettings.SpecVersionMutator = SpecVersionMutator { version -> if (version.major != 1) throw YamlVersionException(version) version }, val bufferSize: Int = 1024, val allowDuplicateKeys: Boolean = false, val allowRecursiveKeys: Boolean = false, val maxAliasesForCollections: Int = 50, val useMarks: Boolean = true, val customProperties: Map<SettingKey, Any> = emptyMap(), val envConfig: EnvConfig? = null, val parseComments: Boolean = false, val codePointLimit: Int = 3 * 1024 * 1024, val schema: Schema = DEFAULT_SCHEMA)(source)

Immutable configuration for loading.

Constructors

LoadSettings

constructor(label: String = "reader", tagConstructors: Map<Tag, ConstructNode> = emptyMap(), defaultList: LoadSettings.CollectionProvider<MutableList<Any?>> = CollectionProvider { initialCapacity: Int -> ArrayList(initialCapacity) }, defaultSet: LoadSettings.CollectionProvider<MutableSet<Any?>> = CollectionProvider { initialCapacity: Int -> LinkedHashSet(initialCapacity) }, defaultMap: LoadSettings.CollectionProvider<MutableMap<Any?, Any?>> = CollectionProvider { initialCapacity: Int -> LinkedHashMap(initialCapacity) }, versionFunction: LoadSettings.SpecVersionMutator = SpecVersionMutator { version -> if (version.major != 1) throw YamlVersionException(version) version }, bufferSize: Int = 1024, allowDuplicateKeys: Boolean = false, allowRecursiveKeys: Boolean = false, maxAliasesForCollections: Int = 50, useMarks: Boolean = true, customProperties: Map<SettingKey, Any> = emptyMap(), envConfig: EnvConfig? = null, parseComments: Boolean = false, codePointLimit: Int = 3 * 1024 * 1024, schema: Schema = DEFAULT_SCHEMA)

Types

CollectionProvider

fun interface CollectionProvider<T>

SpecVersionMutator

fun interface SpecVersionMutator

Properties

allowDuplicateKeys

val allowDuplicateKeys: Boolean = false

YAML 1.2 does require unique keys. To support the backwards compatibility, it is possible to select what should happen when non-unique keys are detected.

allowRecursiveKeys

val allowRecursiveKeys: Boolean = false

Allow only non-recursive keys for maps and sets. By default, it is not allowed. Even though YAML allows using anything as a key, it may cause unexpected issues when loading recursive structures.

bufferSize

val bufferSize: Int = 1024

Buffer size for incoming data stream, in bytes. If the incoming stream is already buffered, then changing the buffer does not improve the performance

codePointLimit

val codePointLimit: Int

The max number of code points for every input YAML document in the stream. Please be aware that the byte limit depends on the encoding. The presence of the document indicators '---' or/and '...' will affect the doc size (even though they do not belong to the document content)

customProperties

val customProperties: Map<SettingKey, Any>

Provide a custom property to be used later

defaultList

val defaultList: LoadSettings.CollectionProvider<MutableList<Any?>>

Default List implementation, as a function of its initial size. ArrayList is used if nothing provided.

defaultMap

val defaultMap: LoadSettings.CollectionProvider<MutableMap<Any?, Any?>>

Default Map implementation, as a function of its initial size. LinkedHashMap is used if nothing provided.

defaultSet

val defaultSet: LoadSettings.CollectionProvider<MutableSet<Any?>>

Default Set implementation, as a function of its initial size. LinkedHashSet is used if nothing provided.

envConfig

val envConfig: EnvConfig? = null

Define EnvConfig to parse ENV format. If not set explicitly, the variable substitution is not applied.

label

val label: String

Label for the input data. Can be used to improve the error message.

maxAliasesForCollections

val maxAliasesForCollections: Int = 50

Restrict the number of aliases for collection nodes to prevent 'billion laughs attack'. The purpose of this setting is to force SnakeYAML to fail before a lot of CPU and memory resources are allocated for the parser. Aliases for scalar nodes do not count because they do not grow exponentially.

parseComments

val parseComments: Boolean = false

Parse comments to the presentation tree (Node). False by default. Use true to parse comments to the presentation tree (Node)

schema

val schema: Schema

Provide either recommended or custom schema instead of default * it.krzeminski.snakeyaml.engine.kmp.schema.DEFAULT_SCHEMA These 3 are available it.krzeminski.snakeyaml.engine.kmp.schema.FailsafeSchema, it.krzeminski.snakeyaml.engine.kmp.schema.JsonSchema, it.krzeminski.snakeyaml.engine.kmp.schema.CoreSchema.

tagConstructors

val tagConstructors: Map<Tag, ConstructNode>

Constructors for the specified tags.

useMarks

val useMarks: Boolean = true

Marks are only used for error messages, but they require a lot of memory. true by default. Use false to save resources but use less informative error messages (no line and context).

versionFunction

val versionFunction: LoadSettings.SpecVersionMutator

Manage YAML directive value which defines the version of the YAML specification. This parser supports YAML 1.2, but it can parse most of YAML 1.1 and YAML 1.0