Class/Object

japgolly.microlibs.config

Config

Related Docs: object Config | package config

Permalink

abstract class Config[A] extends ConfigValidation[Config, A]

Representation the desire to read A from some as-of-yet-unspecified config.

Linear Supertypes
ConfigValidation[Config, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Config
  2. ConfigValidation
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. final def choose[B](f: (A) ⇒ Config[B]): Config[B]

    Permalink
  6. final def chooseAttempt[B](f: (A) ⇒ \/[String, Config[B]]): Config[B]

    Permalink
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensure(test: (A) ⇒ Boolean, errorMsg: ⇒ String): Config[A]

    Permalink
    Definition Classes
    ConfigValidation
  9. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  15. final def map[B](f: (A) ⇒ B): Config[B]

    Permalink
  16. final def mapAttempt[B](f: (A) ⇒ \/[String, B]): Config[B]

    Permalink
    Definition Classes
    ConfigConfigValidation
  17. def mapCatch[B](f: (A) ⇒ B, e: (Throwable) ⇒ String = _.toString): Config[B]

    Permalink
    Definition Classes
    ConfigValidation
  18. def mapOption[B](f: (A) ⇒ Option[B], errorMsg: ⇒ String = "Not a recognised value."): Config[B]

    Permalink
    Definition Classes
    ConfigValidation
  19. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  22. final def obfuscateInReport: Config[A]

    Permalink

    When a japgolly.microlibs.config.ConfigReport is generated, the keys used to populate this A will displayed with their values obfuscated.

  23. final def run[F[_]](sources: Sources[F])(implicit F: Monad[F]): F[ConfigResult[A]]

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

    Permalink
    Definition Classes
    AnyRef
  25. def test(errorMsg: (A) ⇒ Option[String]): Config[A]

    Permalink
    Definition Classes
    ConfigValidation
  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 withCaseInsensitiveKeys: Config[A]

    Permalink
  31. final def withKeyMod(f: (String) ⇒ String): Config[A]

    Permalink
  32. final def withPrefix(prefix: String): Config[A]

    Permalink
  33. final def withReport: Config[(A, ConfigReport)]

    Permalink

    Generate a report based on the usage _so far_.

    Generate a report based on the usage _so far_. This should be at the very end of your Config composition, else the unused-keys portion of the report may be inaccurate.

Inherited from ConfigValidation[Config, A]

Inherited from AnyRef

Inherited from Any

Ungrouped