Trait

zio.config

ConfigDocsModule

Related Doc: package config

Permalink

trait ConfigDocsModule extends WriteModule

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

Type Members

  1. sealed trait ConfigDescriptor[A] extends AnyRef

    Permalink
    Definition Classes
    ConfigDescriptorModule
  2. trait ConfigDescriptorFunctions extends AnyRef

    Permalink
    Definition Classes
    ConfigDescriptorModule
  3. sealed trait ConfigDocs extends AnyRef

    Permalink
  4. trait ConfigSource extends AnyRef

    Permalink
    Definition Classes
    ConfigSourceModule
  5. trait ConfigSourceFunctions extends AnyRef

    Permalink
    Definition Classes
    ConfigSourceModule
  6. case class ConfigSourceName(name: String) extends Product with Serializable

    Permalink
    Definition Classes
    ConfigSourceModule
  7. abstract type K

    Permalink
    Definition Classes
    KeyValueModule
  8. case class LazyConfigDescriptor[A](get: () ⇒ ConfigDescriptor[A]) extends Product with Serializable

    Permalink
    Definition Classes
    ConfigDescriptorModule
  9. sealed trait LeafForSequence extends AnyRef

    Permalink

    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
  10. case class Table(rows: List[TableRow]) extends Product with Serializable

    Permalink

  11. abstract type V

    Permalink
    Definition Classes
    KeyValueModule

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object ConfigDescriptorAdt

    Permalink
    Definition Classes
    ConfigDescriptorModule
  5. object ConfigDocs

    Permalink
  6. object ConfigSourceFunctions extends ConfigSourceFunctions

    Permalink
    Attributes
    protected
    Definition Classes
    ConfigSourceModule
  7. object LeafForSequence

    Permalink
    Definition Classes
    ConfigSourceModule
  8. object Table extends Serializable

    Permalink
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def dump[A](config: ConfigDescriptor[A]): String

    Permalink
    Definition Classes
    ConfigDescriptorModule
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def generateDocs[A](config: ConfigDescriptor[A]): ConfigDocs

    Permalink

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

  16. def generateReport[A](config: ConfigDescriptor[A], value: A): Either[String, ConfigDocs]

    Permalink

    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.

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def getConfigSource(sourceNames: Set[ConfigSourceName], getTree: (List[K]) ⇒ PropertyTree[K, V], isLeafValidSequence: LeafForSequence): ConfigSource

    Permalink
    Attributes
    protected
    Definition Classes
    ConfigSourceModule
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. final def thunk[A](config: ⇒ ConfigDescriptor[A]): LazyConfigDescriptor[A]

    Permalink
    Definition Classes
    ConfigDescriptorModule
  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def write[A](config: ConfigDescriptor[A], a: A): Either[String, PropertyTree[K, V]]

    Permalink
    Definition Classes
    WriteModule

Inherited from WriteModule

Inherited from ConfigDescriptorModule

Inherited from ConfigSourceModule

Inherited from KeyValueModule

Inherited from AnyRef

Inherited from Any

Ungrouped