t

zio.config

ConfigModule

trait ConfigModule extends ConfigDescriptorModule with ConfigSourceModule with ConfigDocsModule with ReadModule with WriteModule

Linear Supertypes
ReadModule, ConfigDocsModule, WriteModule, ConfigDescriptorModule, ConfigSourceModule, KeyValueModule, AnyRef, Any
Known Subclasses
ConfigStringModule
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigModule
  2. ReadModule
  3. ConfigDocsModule
  4. WriteModule
  5. ConfigDescriptorModule
  6. ConfigSourceModule
  7. KeyValueModule
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait ConfigDescriptor[A] extends AnyRef
    Definition Classes
    ConfigDescriptorModule
  2. trait ConfigDescriptorFunctions extends AnyRef
    Definition Classes
    ConfigDescriptorModule
  3. sealed trait ConfigDocs extends AnyRef

    ConfigDocs holds the descriptions and details of a ConfigDescriptor which can be used to produce documentation.

    ConfigDocs holds the descriptions and details of a ConfigDescriptor which can be used to produce documentation.

    Definition Classes
    ConfigDocsModule
  4. sealed case class Table(rows: List[TableRow]) extends Product with Serializable

    A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying to convert ConfigDocs to a readable format.

    A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying to convert ConfigDocs to a readable format.

    Definition Classes
    ConfigDocsModule
  5. type CachedReaders = Map[ConfigSource, ManagedReader]
    Definition Classes
    ReadModule
  6. type K = String
    Definition Classes
    ConfigSourceModule → KeyValueModule
  7. type V = String
    Definition Classes
    ConfigSourceModule → KeyValueModule
  8. sealed trait ConfigSource extends AnyRef

    Every ConfigSource at the core is just a Reader, which is essentially a function that goes from PropertyTreePath to an actual PropertyTree.

    Every ConfigSource at the core is just a Reader, which is essentially a function that goes from PropertyTreePath to an actual PropertyTree. i.e, f: PropertyTreePath[String] => IO[ReadError[String], PropertyTree[String, String] Later on for each key represented as PropertyTreePath[String] internally, f is used to applied to get the value as a PropertyTree itself.

    Internal details:

    This function f can be retrieved under an ZManaged effect. This implies it may involve an IO with managing resources to even form this function. Example: In order to retrieve a property-tree corresponding to a key (PropertyTreePath), it requires a database connection in the very first instance.

    // pseudo-logic, doesn't compile

    val source: ConfigSource = ConfigSource.Reader( ZManaged(getDatabaseConnection) .flatMap(connection => (key: PropertyTreePath[String] => IO.effect(connection.getStatement.executeQuery(s"get key from table"))) )

    Note that ConfigSource has a generalised memoize function that allows you to memoize the effect required to form the function. In the context of the above example, with source.memoize we acquire only a single connection to retrieve the values for all the keys in your product/coproduct for an instance of read.

    Definition Classes
    ConfigSourceModule

Value Members

  1. object Table extends Serializable
    Definition Classes
    ConfigDocsModule
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def configLayer[A](config: ConfigDescriptor[A])(implicit tag: Tag[A]): ZLayer[ConfigSource, ReadError[K], A]

    Convert a ConfigDescriptor to a Layer, which further requires a ConfigSource as input.

    Convert a ConfigDescriptor to a Layer, which further requires a ConfigSource as input. Note: Use configLayer_ instead of configLayer if ConfigSource information is already embedded in the descriptor.

    Example usage:

    final case class MyConfig(age: Int)

val appConfigLayer  =
   ConfigSource.fromMap(Map("age" -> "20")).toLayer >>> configLayer(int("age").to[MyConfig])

val app: ZIO[MyConfig with zio.console.Console,java.io.IOException, Unit] =
  getConfig[MyConfig].flatMap(Console.printLine)

app.provideSomeLayer[Console](appConfigLayer)
// ZIO[zio.console.Console, Exception, Unit]

    This can also be simplified to

    val appConfigLayer  =
 configLayer_(int("age").to[MyConfig] from  ConfigSource.fromMap(Map("age" -> "20")))

app.provideSomeLayer[Console](appConfigLayer)

    The preference depends on how you want to design the entry point to managing config of your app.

  8. final def configLayer_[A](config: ConfigDescriptor[A])(implicit tag: Tag[A]): ZLayer[Any, ReadError[K], A]

    Convert a ConfigDescriptor to a Layer.

    Convert a ConfigDescriptor to a Layer.

    Example usage:

    final case class MyConfig(age: Int, name: String)

object MyConfig {
  val config =
    (int("age") zip string("name")).to[MyConfig] from ConfigSource.fromMap(Map("age" -> "20", "name" -> "afsal"))
}

val app: ZIO[Has[MyConfig] with zio.console.Console, java.io.IOException, Unit] =
  getConfig[MyConfig].flatMap(putStrLn)

val io: ZIO[zio.console.Console, Exception, Unit] =
  app.provideSomeLayer[Console](configLayer_(MyConfig.config))

println(zio.Runtime.default.unsafeRun(io))
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def generateDocs[A](config: ConfigDescriptor[A]): ConfigDocs

    Generate documentation based on the ConfigDescriptor, where a ConfigDescriptor is a structure representing the logic to fetch the application config from various sources.

    Generate documentation based on the ConfigDescriptor, where a ConfigDescriptor is a structure representing the logic to fetch the application config from various sources.

    Once we generate the docs, this can be converted to a light weight Table structure which is much more easier to be converted to markdown or json formats.

    Example :

    val configDescriptor: ConfigDescriptor[MyAppConfig] = ???

generatedDocs(configDescriptor).toTable.toGithubFlavouredMarkdown
    Definition Classes
    ConfigDocsModule
  13. def generateReport[A](config: ConfigDescriptor[A], value: A): Either[String, ConfigDocs]

    Generate a report based on the ConfigDescriptor and an A, where a ConfigDescriptor represents the logic to fetch the application config from various sources, and A represents the actual config value that was retrieved.

    Generate a report based on the ConfigDescriptor and an A, where a ConfigDescriptor represents the logic to fetch the application config from various sources, and A represents the actual config value that was retrieved.

    Definition Classes
    ConfigDocsModule
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def getConfig[A](implicit tag: Tag[A]): ZIO[A, Nothing, A]

    Example usage:

    Example usage:

    A helper method allowing you to forget passing configs as arguments to all over the place in your app. Whereever, you need to access the config, simply call getConfig[MyConfig].flatMap(config => ???).

    PS: if you are familiar with Kleisli, this is similar to using Kleisi[IO, Config, A], except for the fact that it is Has[Config] instead of Config allowing you to mixin with other dependencies keeping your Monad the same

    import zio.console._

final case class MyConfig(username: String, port: Int)

val app: ZIO[Has[MyConfig] with Console, java.io.IOException, Unit] =
  for {
     config <- getConfig[MyConfig]
     _      <- putStrLn(config.toString)
  } yield ()

val configDesc =
  (string("USERNAME") zip int("PORT")).to[MyConfig] from ConfigSource.fromMap(Map())

val main: ZIO[zio.console.Console, Exception, Unit] =
  app.provideSomeLayer[Console](configLayer_(configDesc))
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def read[A](configuration: ConfigDescriptor[A]): IO[ReadError[K], A]
    Definition Classes
    ReadModule
  22. final def requiredZipAndOrFields[A](config: ConfigDescriptor[A]): Int
    Definition Classes
    ReadModule
  23. def sizeOfZipAndOrErrors(error: ReadError[K]): Int
    Definition Classes
    ReadModule
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. final def write[A](config: ConfigDescriptor[A], a: A): Either[String, PropertyTree[K, V]]
    Definition Classes
    WriteModule
  30. object ConfigSource
    Definition Classes
    ConfigSourceModule

Inherited from ReadModule

Inherited from ConfigDocsModule

Inherited from WriteModule

Inherited from ConfigDescriptorModule

Inherited from ConfigSourceModule

Inherited from KeyValueModule

Inherited from AnyRef

Inherited from Any

Ungrouped