Packages

sealed trait Config[+A] extends AnyRef

A zio.Config describes the structure of some configuration data.

Self Type
Config[A]
Linear Supertypes
AnyRef, Any
Known Subclasses
Bool, Composite, Constant, Decimal, Described, Duration, Fail, Fallback, FallbackWith, Integer, Lazy, LocalDate, LocalDateTime, LocalTime, MapOrFail, Nested, OffsetDateTime, Optional, Primitive, SecretType, Sequence, Switch, Table, Text, Zipped
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Config
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ++[B](that: => Config[B])(implicit zippable: Zippable[A, B]): Config[Out]

    Returns a new config that is the composition of this config and the specified config.

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def ??(label: => String): Config[A]

    Adds a description to this configuration, which is intended for humans.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def map[B](f: (A) => B): Config[B]

    Returns a new config whose structure is the same as this one, but which produces a different Scala value, constructed using the specified function.

  14. def mapAttempt[B](f: (A) => B): Config[B]

    Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified function, which may throw exceptions that will be translated into validation errors.

  15. def mapOrFail[B](f: (A) => Either[Error, B]): Config[B]

    Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified fallible function.

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def nested(name: => String, names: String*): Config[A]

    Returns a new config that has this configuration nested as a property of the specified name.

  18. def nested(name: => String): Config[A]

    Returns a new config that has this configuration nested as a property of the specified name.

  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def optional: Config[Option[A]]

    Returns an optional version of this config, which will be None if the data is missing from configuration, and Some otherwise.

  22. def orElse[A1 >: A](that: => Config[A1]): Config[A1]

    A named version of ||.

  23. def orElseIf(condition: (Error) => Boolean): OrElse[A]

    Returns configuration which reads from this configuration, but which falls back to the specified configuration if reading from this configuration fails with an error satisfying the specified predicate.

  24. def repeat: Config[Chunk[A]]

    Returns a new config that describes a sequence of values, each of which has the structure of this config.

  25. def switch[A1 >: A, B](f: (A1, Config[B])*): Config[B]

    Returns a new configuration which reads from this configuration and uses the resulting value to determine the configuration to read from.

  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. def validate(message: => String)(f: (A) => Boolean): Config[A]

    Returns a new config that describes the same structure as this one, but which performs validation during loading.

  29. def validateWith[B](message: => String)(pf: PartialFunction[A, B]): Config[B]

    Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified partial function, failing with the specified validation error if the partial function is not defined.

  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. def withDefault[A1 >: A](default: => A1): Config[A1]

    Returns a new config that describes the same structure as this one, but has the specified default value in case the information cannot be found.

  34. def zip[B](that: => Config[B])(implicit z: Zippable[A, B]): Config[Out]

    A named version of ++.

  35. def zipWith[B, C](that: => Config[B])(f: (A, B) => C): Config[C]

    Returns a new configuration that is the composition of this configuration and the specified configuration, combining their values using the function f.

  36. def ||[A1 >: A](that: => Config[A1]): Config[A1]

    Returns a config whose structure is preferentially described by this config, but which falls back to the specified config if there is an issue reading from this config.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped