sealed trait Config[+A] extends AnyRef
A zio.Config describes the structure of some configuration data.
- Self Type
- Config[A]
- Alphabetic
- By Inheritance
- Config
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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.
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
??(label: ⇒ String): Config[A]
Adds a description to this configuration, which is intended for humans.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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.
-
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.
-
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.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nested(name: ⇒ String, names: String*): Config[A]
Returns a new config that has this configuration nested as a property of the specified name.
-
def
nested(name: ⇒ String): Config[A]
Returns a new config that has this configuration nested as a property of the specified name.
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
optional: Config[Option[A]]
Returns an optional version of this config, which will be
None
if the data is missing from configuration, andSome
otherwise. -
def
orElse[A1 >: A](that: ⇒ Config[A1]): Config[A1]
A named version of
||
. -
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.
-
def
repeat: Config[Chunk[A]]
Returns a new config that describes a sequence of values, each of which has the structure of this config.
-
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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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.
-
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.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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.
-
def
zip[B](that: ⇒ Config[B])(implicit z: Zippable[A, B]): Config[Out]
A named version of
++
. -
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
. -
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.