Packages

  • package root

    This is the API documentation for Ciris: lightweight, extensible, and validated configuration loading in Scala.
    The documentation is kept up-to-date with new releases, currently documenting release v0.12.1 on Scala 2.12.
    Please note that the documentation targets the JVM, and there may be differences on Scala.js and Scala Native.

    This is the API documentation for Ciris: lightweight, extensible, and validated configuration loading in Scala.
    The documentation is kept up-to-date with new releases, currently documenting release v0.12.1 on Scala 2.12.
    Please note that the documentation targets the JVM, and there may be differences on Scala.js and Scala Native.

    Ciris is divided into the following set of modules.

    • The cats module integrates with cats for type classes and type class instances.
    • The cats-effect module integrates with cats-effect for type classes for effect types.
    • The core module provides basic functionality and support for standard library types.
    • The enumeratum module integrates with enumeratum to be able to read enumerations.
    • The generic module uses shapeless to be able to read products and coproducts.
    • The refined module integrates with refined to be able to read refinement types.
    • The spire module integrates with spire to be able to read more number types.
    • The squants module integrates with squants to read values with unit of measure.

    If you're looking for usage instructions, please refer to the usage guide.

    Definition Classes
    root
  • package ciris

    The main namespace of Ciris is ciris, and the easiest way to get started is to bring it into scope with an import.
    If you are looking for a getting started guide, with examples and explanations, please refer to the usage guide.

    The main namespace of Ciris is ciris, and the easiest way to get started is to bring it into scope with an import.
    If you are looking for a getting started guide, with examples and explanations, please refer to the usage guide.

    Definition Classes
    root
  • object ConfigSource extends ConfigSourcePlatformSpecific
    Definition Classes
    ciris
  • Environment
  • File
  • Properties
o

ciris.ConfigSource

Properties

object Properties extends ConfigSource[Id, String, String]

ConfigSource reading system properties from String keys.

Source
ConfigSource.scala
Linear Supertypes
ConfigSource[Id, String, String], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Properties
  2. ConfigSource
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val keyType: ConfigKeyType[String]
    Definition Classes
    ConfigSource
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def read(key: String): ConfigEntry[Id, String, String, String]

    Reads the value of type V for the specified key of type K, and returns a ConfigEntry with the result wrapped in the context F.

    Reads the value of type V for the specified key of type K, and returns a ConfigEntry with the result wrapped in the context F. If there was an error while reading the value, ConfigEntry#value will have more details.

    key

    the key for which to read the value

    returns

    a ConfigEntry with the result

    Definition Classes
    PropertiesConfigSource
    Example:
    1. scala> ConfigSource.Environment.read("key").toStringWithValues
      res0: String = ConfigEntry(key, Environment, Left(MissingKey(key, Environment)))
  17. final def suspendF[G[_]](implicit arg0: Sync[G], f: ~>[Id, G]): ConfigSource[G, String, String]

    Suspends the reading of this configuration source into context G.

    Suspends the reading of this configuration source into context G.

    G

    the context in which to suspend the reading

    f

    the natural transformation from F to G

    returns

    a new ConfigSource

    Definition Classes
    ConfigSource
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    Properties → AnyRef → Any
  20. final def transformF[G[_]](implicit arg0: Apply[G], f: ~>[Id, G]): ConfigSource[G, String, String]

    Transforms the context F, for the source, to context G.

    Transforms the context F, for the source, to context G.

    G

    the context to which F should be transformed

    f

    the natural transformation from F to G

    returns

    a new ConfigSource

    Definition Classes
    ConfigSource
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from ConfigSource[Id, String, String]

Inherited from AnyRef

Inherited from Any

Ungrouped