t

zio.config

ConfigModule

trait ConfigModule extends 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. abstract type K
    Definition Classes
    KeyValueModule
  6. abstract type V
    Definition Classes
    KeyValueModule
  7. trait ConfigSource extends AnyRef
    Definition Classes
    ConfigSourceModule
  8. trait ConfigSourceFunctions extends AnyRef
    Definition Classes
    ConfigSourceModule
  9. case class ConfigSourceName(name: String) extends Product with Serializable
    Definition Classes
    ConfigSourceModule
  10. sealed trait LeafForSequence extends AnyRef

    To specify if a singleton leaf should be considered as a valid sequence or not.

    To specify if a singleton leaf should be considered as a valid sequence or not.

    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 eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. 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
  11. 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
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def getConfig[A](implicit tag: zio.Tag[A]): ZIO[Has[A], Nothing, A]
  14. def getConfigSource(sourceNames: Set[ConfigSourceName], getTree: (List[K]) ⇒ PropertyTree[K, V], isLeafValidSequence: LeafForSequence): ConfigSource
    Attributes
    protected
    Definition Classes
    ConfigSourceModule
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def read[A](configuration: ConfigDescriptor[A]): Either[ReadError[K], A]
    Definition Classes
    ReadModule
  21. final def requiredZipAndOrFields[A](config: ConfigDescriptor[A]): Int
    Definition Classes
    ReadModule
  22. def sizeOfZipAndOrErrors(error: ReadError[K]): Int
    Definition Classes
    ReadModule
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. final def write[A](config: ConfigDescriptor[A], a: A): Either[String, PropertyTree[K, V]]
    Definition Classes
    WriteModule
  29. object ConfigSourceFunctions extends ConfigSourceFunctions
    Attributes
    protected
    Definition Classes
    ConfigSourceModule
  30. object LeafForSequence
    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