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.0 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.0 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.

  • 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.

p

root package

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.0 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.

Ungrouped