pureconfig-yaml
API
Generated with
pureconfig-yaml/pureconfig.module.yaml

pureconfig.module.yaml

package pureconfig.module.yaml

Members list

Packages

package pureconfig.module.yaml.error

Type members

Classlikes

final class YamlConfigSource extends ConfigSource

A ConfigSource that reads configs from YAML documents in a stream, file or string.

A ConfigSource that reads configs from YAML documents in a stream, file or string.

Value parameters

getReader

the thunk to generate a Reader instance from which the YAML document will be read. This parameter won't be memoized so it can be used with dynamic sources (e.g. URLs)

onIOFailure

an optional function used to provide a custom failure when IO errors happen

uri

the optional URI of the source. Used only to provide better error messages.

Attributes

Companion
object
Supertypes
trait ConfigSource
class Object
trait Matchable
class Any
object YamlConfigSource

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type

Value members

Deprecated methods

def loadYaml[Config](path: Path)(implicit reader: ConfigReader[Config]): Result[Config]

Loads a configuration of type Config from the given YAML file.

Loads a configuration of type Config from the given YAML file.

Value parameters

path

the path of the YAML file to read

Attributes

Returns

A Success with the configuration if it is possible to create an instance of type Config from the YAML file, else a Failure with details on why it isn't possible

Deprecated
true
def loadYaml[Config](path: Path, namespace: String)(implicit reader: ConfigReader[Config]): Result[Config]

Loads a configuration of type Config from the given YAML file.

Loads a configuration of type Config from the given YAML file.

Value parameters

namespace

the base namespace from which the configuration should be load

path

the path of the YAML file to read

Attributes

Returns

A Success with the configuration if it is possible to create an instance of type Config from the YAML file, else a Failure with details on why it isn't possible

Deprecated
true
def loadYaml[Config](content: String)(implicit reader: ConfigReader[Config]): Result[Config]

Loads a configuration of type Config from the given string.

Loads a configuration of type Config from the given string.

Value parameters

content

the string containing the YAML document

Attributes

Returns

A Success with the configuration if it is possible to create an instance of type Config from content, else a Failure with details on why it isn't possible

Deprecated
true
def loadYaml[Config](content: String, namespace: String)(implicit reader: ConfigReader[Config]): Result[Config]

Attributes

Deprecated
true
def loadYamlOrThrow[Config : ClassTag](path: Path)(implicit evidence$1: ClassTag[Config], reader: ConfigReader[Config]): Config

Loads a configuration of type Config from the given YAML file.

Loads a configuration of type Config from the given YAML file.

Value parameters

path

the path of the YAML file to read

Attributes

Returns

the configuration

Deprecated
true
def loadYamlOrThrow[Config : ClassTag](path: Path, namespace: String)(implicit evidence$1: ClassTag[Config], reader: ConfigReader[Config]): Config

Loads a configuration of type Config from the given YAML file.

Loads a configuration of type Config from the given YAML file.

Value parameters

namespace

the base namespace from which the configuration should be load

path

the path of the YAML file to read

Attributes

Returns

the configuration

Deprecated
true
def loadYamlOrThrow[Config : ClassTag](content: String)(implicit evidence$1: ClassTag[Config], reader: ConfigReader[Config]): Config

Loads a configuration of type Config from the given string.

Loads a configuration of type Config from the given string.

Value parameters

content

the string containing the YAML document

Attributes

Returns

the configuration

Deprecated
true
def loadYamlOrThrow[Config : ClassTag](content: String, namespace: String)(implicit evidence$1: ClassTag[Config], reader: ConfigReader[Config]): Config

Loads a configuration of type Config from the given string.

Loads a configuration of type Config from the given string.

Value parameters

content

the string containing the YAML document

namespace

the base namespace from which the configuration should be load

Attributes

Returns

the configuration

Deprecated
true
def loadYamls[Config](path: Path)(implicit reader: ConfigReader[Config]): Result[Config]

Loads a configuration of type Config from the given multi-document YAML file. Config must have a ConfigReader supporting reading from config lists.

Loads a configuration of type Config from the given multi-document YAML file. Config must have a ConfigReader supporting reading from config lists.

Value parameters

path

the path of the YAML file to read

Attributes

Returns

A Success with the configuration if it is possible to create an instance of type Config from the multi-document YAML file, else a Failure with details on why it isn't possible

Deprecated
true
def loadYamls[Config](content: String)(implicit reader: ConfigReader[Config]): Result[Config]

Loads a configuration of type Config from the given multi-document string. Config must have a ConfigReader supporting reading from config lists.

Loads a configuration of type Config from the given multi-document string. Config must have a ConfigReader supporting reading from config lists.

Value parameters

content

the string containing the YAML documents

Attributes

Returns

A Success with the configuration if it is possible to create an instance of type Config from the multi-document string, else a Failure with details on why it isn't possible

Deprecated
true
def loadYamlsOrThrow[Config : ClassTag](path: Path)(implicit evidence$1: ClassTag[Config], reader: ConfigReader[Config]): Config

Loads a configuration of type Config from the given multi-document YAML file. Config must have a ConfigReader supporting reading from config lists.

Loads a configuration of type Config from the given multi-document YAML file. Config must have a ConfigReader supporting reading from config lists.

Value parameters

path

the path of the YAML file to read

Attributes

Returns

the configuration

Deprecated
true
def loadYamlsOrThrow[Config : ClassTag](content: String)(implicit evidence$1: ClassTag[Config], reader: ConfigReader[Config]): Config

Loads a configuration of type Config from the given multi-document string. Config must have a ConfigReader supporting reading from config lists.

Loads a configuration of type Config from the given multi-document string. Config must have a ConfigReader supporting reading from config lists.

Value parameters

content

the string containing the YAML documents

Attributes

Returns

the configuration

Deprecated
true
Generated with