laika.api.config

API for retrieving configuration values based on a string key and a decoder.

Config instances are used in many places in this library, each Document, DocumentTree and Directive has a Config instance associated with it.

One use case for configuration is controlling the behaviour of built-in features, like setting the navigation order or the depth for table of contents.

A second use case is user configuration, where custom variables can be set in configuration files or headers and then referenced in templates or markup with the syntax ${ref.path}.

The key is a path separated by '.', which allows to reference nested objects in the configuration.

Built-in decoders are available for simple types like String, Int, Double, Boolean and any Seq consisting of those values.

It also comes with a decoder for Path, which resolves relative paths in the configuration against the (virtual) path of the origin.

This API is usually used with values obtained by parsing HOCON, as specified in https://github.com/lightbend/config/blob/master/HOCON.md, but the API is generic and can also be used with values specified programmatically.

Please note that Laika does not depend on the Typesafe Config library or any of its commonly used Scala wrappers or forks. It has its own HOCON parser, which implements the full spec while still being minimal and lightweight. It also ensures the FP properties are kept intact, e.g. it has full referential transparency and does not throw Exceptions like most of the alternatives.

Attributes

Companion: object
Source: Config.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: Config.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Config.type

A builder for creating a Config instance programmatically.

While it's most common in Laika that Config instances are obtained by parsing HOCON, instances can also be created entirely programmatically, or by a combination of HOCON and programmatic values if an existing fallback is used with builder.

Attributes

Companion: object
Source: ConfigBuilder.scala
Supertypes: class Object

trait Matchable

class Any

Companion factory for ConfigBuilder instances.

Attributes

Companion: class
Source: ConfigBuilder.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ConfigBuilder.type

A type class that can decode a ConfigValue to an instance of T.

Attributes

Companion: object
Source: ConfigDecoder.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ConfigDecoder[T]

Companion containing default decoder implementations for simple values and Seq's.

Attributes

Companion: trait
Source: ConfigDecoder.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ConfigDecoder.type

A type class that can encode a value of type T as a ConfigValue.

Attributes

Companion: object
Source: ConfigEncoder.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ConfigEncoder[T]

Companion containing default encoder implementations for simple values and Seq's.

Attributes

Companion: trait
Source: ConfigEncoder.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ConfigEncoder.type

Base trait for all configuration errors that occurred during parsing, resolving, retrieving or decoding configuration values.

Attributes

Companion: object
Source: ConfigError.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class DecodingFailed

class DocumentErrors

class InvalidFields

class InvalidType

class MultipleErrors

class NotFound

class ParsingFailed

class ResolverFailed

class ResourceLoadingFailed

class TreeErrors

class ValidationFailed
Show all

Attributes

Companion: trait
Source: ConfigError.scala
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: ConfigError.type

A parser for obtaining a Config instance from a HOCON string.

The HOCON format expected by this parsers is specified at https://github.com/lightbend/config/blob/master/HOCON.md

Attributes

Companion: object
Source: ConfigParser.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: ConfigParser.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ConfigParser.type

The base trait for all configuration values.

This data structure is quite similar to those found in common JSON libraries (HOCON is a JSON superset after all).

The only exception is one special type: the ASTValue which can hold an instance of a document AST obtained from parsing text markup.

This can be useful in scenarios where substitution variables in templates or markup want to refer to other AST elements and include them into their AST tree as is.

Attributes

Companion: object
Source: ConfigValue.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class ASTValue

class ArrayValue

class ObjectValue

trait SimpleValue

class BooleanValue

class DoubleValue

class LongValue

object NullValue

class StringValue
Show all

Attributes

Companion: trait
Source: ConfigValue.scala
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: ConfigValue.type

A defaultKey can be used for commonly used configuration objects like AutonumberConfig that are expected to be mapped to a specific key, like autonumbering without requiring the user to remember these keys.

val config: Config = ???
val res: ConfigResult[AutonumberConfig] = config.get[AutonumberConfig]

In the example above retrieval happens solely based on the type of the result with the associated key being specified by an implicit DefaultKey.

Attributes

Companion: object
Source: DefaultKey.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: DefaultKey.scala
Supertypes: class Object

trait Matchable

class Any
Self type: DefaultKey.type

A single field of an object value.

Attributes

Source: ConfigValue.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Source: Key.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: Key.scala
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Key.type

The origin of a configuration value.

Origins can be used to distinguish values from a specific Config instance from those which were inherited from a fallback, which might be relevant in scenarios where relative paths need to be resolved.

Value parameters

path: the virtual path of containing config instance in a document tree (not the key inside the configuration)
scope: the scope of the containing config instance
sourcePath: the path in the file system this configuration originates from, empty if it was constructed in memory

Attributes

Companion: object
Source: ConfigValue.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ConfigValue.scala
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Origin.type

A value tagged with its origin.

Attributes

Source: ConfigValue.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

laika.api.config

Members list

Type members

Classlikes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes