Package

pureconfig.module

yaml

Permalink

package yaml

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. yaml
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class YamlConfigSource extends ConfigSource

    Permalink

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

Value Members

  1. object YamlConfigSource

    Permalink

  2. package error

    Permalink

Deprecated Value Members

  1. def loadYaml[Config](content: String, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Result[Config]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.string(content).at(namespace).load[Config] instead

  2. def loadYaml[Config](content: String)(implicit reader: Derivation[ConfigReader[Config]]): Result[Config]

    Permalink

    Loads a configuration of type Config from the given string.

    Loads a configuration of type Config from the given string.

    content

    the string containing the YAML document

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.string(content).load[Config] instead

  3. def loadYaml[Config](path: Path, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Result[Config]

    Permalink

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

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

    path

    the path of the YAML file to read

    namespace

    the base namespace from which the configuration should be load

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.file(path).at(namespace).load[Config] instead

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

    Permalink

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

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

    path

    the path of the YAML file to read

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.file(path).load[Config] instead

  5. def loadYamlOrThrow[Config](content: String, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Permalink

    Loads a configuration of type Config from the given string.

    Loads a configuration of type Config from the given string.

    content

    the string containing the YAML document

    namespace

    the base namespace from which the configuration should be load

    returns

    the configuration

    Annotations
    @throws( ... ) @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.string(content).at(namespace).loadOrThrow[Config] instead

  6. def loadYamlOrThrow[Config](content: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Permalink

    Loads a configuration of type Config from the given string.

    Loads a configuration of type Config from the given string.

    content

    the string containing the YAML document

    returns

    the configuration

    Annotations
    @throws( ... ) @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.string(content).loadOrThrow[Config] instead

  7. def loadYamlOrThrow[Config](path: Path, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Permalink

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

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

    path

    the path of the YAML file to read

    namespace

    the base namespace from which the configuration should be load

    returns

    the configuration

    Annotations
    @throws( ... ) @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.file(path).at(namespace).loadOrThrow[Config] instead

  8. def loadYamlOrThrow[Config](path: Path)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Permalink

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

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

    path

    the path of the YAML file to read

    returns

    the configuration

    Annotations
    @throws( ... ) @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.file(path).loadOrThrow[Config] instead

  9. def loadYamls[Config](content: String)(implicit reader: Derivation[ConfigReader[Config]]): Result[Config]

    Permalink

    Loads a configuration of type Config from the given multi-document string.

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

    content

    the string containing the YAML documents

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.string(content).multiDoc.load[Config] instead

  10. def loadYamls[Config](path: Path)(implicit reader: Derivation[ConfigReader[Config]]): Result[Config]

    Permalink

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

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

    path

    the path of the YAML file to read

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.file(path).multiDoc.load[Config] instead

  11. def loadYamlsOrThrow[Config](content: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Permalink

    Loads a configuration of type Config from the given multi-document string.

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

    content

    the string containing the YAML documents

    returns

    the configuration

    Annotations
    @throws( ... ) @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.string(content).multiDoc.loadOrThrow[Config] instead

  12. def loadYamlsOrThrow[Config](path: Path)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Permalink

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

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

    path

    the path of the YAML file to read

    returns

    the configuration

    Annotations
    @throws( ... ) @deprecated
    Deprecated

    (Since version 0.12.1) Use YamlConfigSource.file(path).multiDoc.loadOrThrow[Config] instead

Inherited from AnyRef

Inherited from Any

Ungrouped