pureconfig

package pureconfig

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. pureconfig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait ConfigConvert[T] extends AnyRef

    Trait for conversion between T and RawConfig where T is a "complex" type.

  2. trait FieldConvert[T] extends AnyRef

    Utility trait used as strategy for conversion of a type T from/to a configuration of type RawConfig.

  3. trait StringConvert[T] extends AnyRef

    Conversion between a type T and String with error handling for the conversion from String to T

Value Members

  1. object ConfigConvert

  2. object FieldConvert

  3. object StringConvert

  4. def loadConfig[Config](conf: RawConfig, namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]

    Load a configuration of type Config from the given RawConfig

  5. def loadConfig[Config](conf: RawConfig)(implicit conv: ConfigConvert[Config]): Try[Config]

    Load a configuration of type Config from the given RawConfig

  6. def loadConfig[Config](path: Path, namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]

    Load a configuration of type Config from the given file.

    Load a configuration of type Config from the given file. Note that standard configuration files are still loaded but can be overridden from the given configuration file

    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 configuration files, else a Failure with details on why it isn't possible

  7. def loadConfig[Config](path: Path)(implicit conv: ConfigConvert[Config]): Try[Config]

    Load a configuration of type Config from the given file.

    Load a configuration of type Config from the given file. Note that standard configuration files are still loaded but can be overridden from the given configuration file

    returns

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

  8. def loadConfig[Config](namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]

    Load a configuration of type Config from the standard configuration files

    Load a configuration of type Config from the standard configuration files

    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 configuration files, else a Failure with details on why it isn't possible

  9. def loadConfig[Config](implicit conv: ConfigConvert[Config]): Try[Config]

    Load a configuration of type Config from the standard configuration files

    Load a configuration of type Config from the standard configuration files

    returns

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

  10. def saveConfigAsPropertyFile[Config](conf: Config, outputPath: Path, overrideOutputPath: Boolean = false)(implicit conv: ConfigConvert[Config]): Unit

    Save the given configuration into a property file

    Save the given configuration into a property file

    conf

    The configuration to save

    outputPath

    Where to write the configuration

    overrideOutputPath

    Override the path if it already exists

    Annotations
    @throws( ... )
  11. def saveConfigToStream[Config](conf: Config, outputStream: OutputStream)(implicit conv: ConfigConvert[Config]): Unit

    Writes the configuration to the output stream and closes the stream

    Writes the configuration to the output stream and closes the stream

    conf

    The configuration to write

    outputStream

    The stream in which the configuration should be written

Inherited from AnyRef

Inherited from Any

Ungrouped