package yaml
- Alphabetic
- By Inheritance
- yaml
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
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 typeConfig
fromcontent
, else aFailure
with details on why it isn't possible
-
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 typeConfig
from the YAML file, else aFailure
with details on why it isn't possible
-
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( ... )
-
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( ... )
-
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 aConfigReader
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 typeConfig
from the multi-document string, else aFailure
with details on why it isn't possible
-
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 aConfigReader
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 typeConfig
from the multi-document YAML file, else aFailure
with details on why it isn't possible
-
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 aConfigReader
supporting reading from config lists.- content
the string containing the YAML documents
- returns
the configuration
- Annotations
- @throws( ... )
-
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 aConfigReader
supporting reading from config lists.- path
the path of the YAML file to read
- returns
the configuration
- Annotations
- @throws( ... )