Packages

p

pureconfig.module

catseffect

package catseffect

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

Value Members

  1. def loadConfigF[F[_], A](implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

    Load a configuration of type A from the standard configuration files

    Load a configuration of type A from the standard configuration files

    returns

    The returned action will complete with A if it is possible to create an instance of type A from the configuration files, or fail with a ConfigReaderException which in turn contains details on why it isn't possible

  2. def loadF[F[_], A](cs: ConfigSource)(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]
  3. def saveConfigAsPropertyFileF[F[_], A](conf: A, outputPath: Path, overrideOutputPath: Boolean = false, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit F: Sync[F], writer: Derivation[ConfigWriter[A]]): F[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

    options

    the config rendering options

    returns

    The return action will save out the supplied configuration upon invocation

  4. def saveConfigToStreamF[F[_], A](conf: A, outputStream: OutputStream, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit F: Sync[F], writer: Derivation[ConfigWriter[A]]): F[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

    options

    the config rendering options

    returns

    The return action will save out the supplied configuration upon invocation

Deprecated Value Members

  1. val defaultNameSpace: String
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Root will be treated as the default namespace

  2. def loadConfigF[F[_], A](conf: Config, namespace: String)(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

    Load a configuration of type A from the given Config

    Load a configuration of type A from the given Config

    returns

    The returned action will complete with A if it is possible to create an instance of type A from the configuration object, or fail with a ConfigReaderException which in turn contains details on why it isn't possible

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use ConfigSource.fromConfig(conf).at(namespace).loadF[F, A] instead

  3. def loadConfigF[F[_], A](conf: Config)(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

    Load a configuration of type A from the given Config

    Load a configuration of type A from the given Config

    returns

    The returned action will complete with A if it is possible to create an instance of type A from the configuration object, or fail with a ConfigReaderException which in turn contains details on why it isn't possible

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use ConfigSource.fromConfig(conf).loadF[F, A] instead

  4. def loadConfigF[F[_], A](path: Path, namespace: String)(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

    Load a configuration of type A from the given file.

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

    path

    the path of the configuration file from which to load

    namespace

    the base namespace from which the configuration should be load

    returns

    The returned action will complete with A if it is possible to create an instance of type A from the configuration file, or fail with a ConfigReaderException which in turn contains details on why it isn't possible

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use ConfigSource.default(ConfigSource.file(path)).at(namespace).loadF[F, A] instead

  5. def loadConfigF[F[_], A](path: Path)(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

    Load a configuration of type A from the given file.

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

    path

    the path of the configuration file from which to load

    returns

    The returned action will complete with A if it is possible to create an instance of type A from the configuration file, or fail with a ConfigReaderException which in turn contains details on why it isn't possible

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use ConfigSource.default(ConfigSource.file(path)).loadF[F, A] instead

  6. def loadConfigF[F[_], A](namespace: String)(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

    Load a configuration of type A from the standard configuration files

    Load a configuration of type A from the standard configuration files

    namespace

    the base namespace from which the configuration should be load

    returns

    The returned action will complete with A if it is possible to create an instance of type A from the configuration files, or fail with a ConfigReaderException which in turn contains details on why it isn't possible

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use ConfigSource.default.at(namespace).loadF[F, A] instead

  7. def loadConfigFromFilesF[F[_], A](files: NonEmptyList[Path])(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

    Loads files in order, allowing values in later files to backstop missing values from prior, and converts them into a A.

    Loads files in order, allowing values in later files to backstop missing values from prior, and converts them into a A.

    This is a convenience method which enables having default configuration which backstops local configuration.

    Note: If an element of files references a file which doesn't exist or can't be read, it will silently be ignored.

    files

    Files ordered in decreasing priority containing part or all of a A. Must not be empty.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Construct a custom ConfigSource pipeline instead

Inherited from AnyRef

Inherited from Any

Ungrouped