catseffect

Value Members

def blockingSaveConfigAsPropertyFileF[F[_], A](conf: A, outputPath: Path, blocker: Blocker, overrideOutputPath: Boolean = false, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit F: Sync[F], csf: ContextShift[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
blocker
the blocking context which will be used to load 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
def blockingSaveConfigToStreamF[F[_], A](conf: A, outputStream: OutputStream, blocker: Blocker, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit F: Sync[F], csf: ContextShift[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
blocker
the blocking context which will be used to load the configuration.
options
the config rendering options
returns
The return action will save out the supplied configuration upon invocation
def loadConfigF[F[_], A](blocker: Blocker)(implicit F: Sync[F], csf: ContextShift[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
blocker
the blocking context which will be used to load the configuration.
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
def loadF[F[_], A](cs: ConfigSource, blocker: Blocker)(implicit F: Sync[F], csf: ContextShift[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

Load a configuration of type A from a config source
Load a configuration of type A from a config source
cs
the config source from where the configuration will be loaded
blocker
the blocking context which will be used to load the configuration.
returns
The returned action will complete with A if it is possible to create an instance of type A from the configuration source, or fail with a ConfigReaderException which in turn contains details on why it isn't possible
package syntax

Deprecated Value Members

val defaultNameSpace: String

Annotations
@deprecated
Deprecated
(Since version 0.12.0) Root will be treated as the default namespace
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
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
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
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
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
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

Annotations
@deprecated
Deprecated
(Since version 0.12.3) Use loadConfigF[F, A](blocker) instead
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
def loadF[F[_], A](cs: ConfigSource)(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

Load a configuration of type A from a config source
Load a configuration of type A from a config source
cs
the config source from where the configuration will be loaded
returns
The returned action will complete with A if it is possible to create an instance of type A from the configuration source, or fail with a ConfigReaderException which in turn contains details on why it isn't possible

Annotations
@deprecated
Deprecated
(Since version 0.12.3) Use loadF[F, A](cs, blocker) instead
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

Annotations
@deprecated
Deprecated
(Since version 0.12.3) Use blockingSaveConfigAsPropertyFileF[IO, A](conf, outputPat, blocker, overrideOutputPath, options) instead
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

Annotations
@deprecated
Deprecated
(Since version 0.12.3) Use blockingSaveConfigToStreamF[IO, A](conf, outputStream, blocker, options) instead

package catseffect

Value Members

def blockingSaveConfigAsPropertyFileF[F[_], A](conf: A, outputPath: Path, blocker: Blocker, overrideOutputPath: Boolean = false, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit F: Sync[F], csf: ContextShift[F], writer: Derivation[ConfigWriter[A]]): F[Unit]

def blockingSaveConfigToStreamF[F[_], A](conf: A, outputStream: OutputStream, blocker: Blocker, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit F: Sync[F], csf: ContextShift[F], writer: Derivation[ConfigWriter[A]]): F[Unit]

def loadConfigF[F[_], A](blocker: Blocker)(implicit F: Sync[F], csf: ContextShift[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

def loadF[F[_], A](cs: ConfigSource, blocker: Blocker)(implicit F: Sync[F], csf: ContextShift[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

package syntax

Deprecated Value Members

val defaultNameSpace: String

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

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

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

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

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

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

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

def loadF[F[_], A](cs: ConfigSource)(implicit F: Sync[F], reader: Derivation[ConfigReader[A]], ct: ClassTag[A]): F[A]

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]

def saveConfigToStreamF[F[_], A](conf: A, outputStream: OutputStream, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit F: Sync[F], writer: Derivation[ConfigWriter[A]]): F[Unit]

Inherited from AnyRef

Inherited from Any

Ungrouped