yaml

Value Members

1. package error

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

   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

3. def loadYaml[Config](path: Path)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

   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

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

   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( ... )

5. def loadYamlOrThrow[Config](path: Path)(implicit arg0: ClassTag[Config], reader: Derivation[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.

   path

   the path of the YAML file to read

   returns

   the configuration

   Annotations

   @throws( ... )

6. def loadYamls[Config](content: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

   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

7. def loadYamls[Config](path: Path)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

   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

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

   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( ... )

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

   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( ... )