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.

    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
  • package api
    Definition Classes
    ciris
  • package cats

    Module providing an integration with cats.

    Module providing an integration with cats.

    Definition Classes
    ciris
  • package api
  • package effect

    Module providing an integration with cats-effect.

  • package decoders
    Definition Classes
    ciris
  • package enumeratum

    Module providing an integration with enumeratum.

    Module providing an integration with enumeratum.

    Definition Classes
    ciris
  • package generic

    Module using shapeless for generic derivation of ConfigDecoders.

    Module using shapeless for generic derivation of ConfigDecoders.

    Definition Classes
    ciris
  • package refined

    Module providing an integration with refined.

    Module providing an integration with refined.

    Definition Classes
    ciris
  • package spire

    Module providing an integration with spire.

    Module providing an integration with spire.

    Definition Classes
    ciris
  • package squants

    Module providing an integration with squants.

    Module providing an integration with squants.

    Definition Classes
    ciris
p

ciris

cats

package cats

Module providing an integration with cats.

Source
package.scala
Linear Supertypes
CirisInstancesForCats, CatsInstancesForCiris, CatsInstancesForCiris1, CatsInstancesForCiris2, CatsInstancesForCiris3, CatsInstancesForCiris4, CatsInstancesForCiris5, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. cats
  2. CirisInstancesForCats
  3. CatsInstancesForCiris
  4. CatsInstancesForCiris1
  5. CatsInstancesForCiris2
  6. CatsInstancesForCiris3
  7. CatsInstancesForCiris4
  8. CatsInstancesForCiris5
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. implicit def catsApplicativeErrorToCiris[F[_], E](implicit ae: ApplicativeError[F, E]): ApplicativeError[F, E]
    Definition Classes
    CatsInstancesForCiris1
  2. implicit def catsApplicativeToCiris[F[_]](implicit a: Applicative[F]): Applicative[F]
    Definition Classes
    CatsInstancesForCiris3
  3. implicit def catsApplyToCiris[F[_]](implicit a: Apply[F]): Apply[F]
    Definition Classes
    CatsInstancesForCiris4
  4. implicit def catsFlatMapToCiris[F[_]](implicit fm: FlatMap[F]): FlatMap[F]
    Definition Classes
    CatsInstancesForCiris3
  5. implicit def catsFunctionKToCiris[F[_], G[_]](implicit fk: ~>[F, G]): FunctionK[F, G]
    Definition Classes
    CatsInstancesForCiris
  6. implicit def catsFunctorToCiris[F[_]](implicit fu: Functor[F]): Functor[F]
    Definition Classes
    CatsInstancesForCiris5
  7. implicit def catsMonadErrorToCiris[F[_], E](implicit me: MonadError[F, E]): MonadError[F, E]
    Definition Classes
    CatsInstancesForCiris
  8. implicit def catsMonadToCiris[F[_]](implicit m: Monad[F]): Monad[F]
    Definition Classes
    CatsInstancesForCiris2
  9. implicit val semigroupConfigErrors: Semigroup[ConfigErrors]
    Definition Classes
    CirisInstancesForCats
  10. implicit def showConfigEntry[F[_], K, S, V](implicit showKey: Show[K], showKeyType: Show[ConfigKeyType[K]]): Show[ConfigEntry[F, K, S, V]]
    Definition Classes
    CirisInstancesForCats
  11. implicit val showConfigError: Show[ConfigError]
    Definition Classes
    CirisInstancesForCats
  12. implicit val showConfigErrors: Show[ConfigErrors]
    Definition Classes
    CirisInstancesForCats
  13. implicit val showConfigException: Show[ConfigException]
    Definition Classes
    CirisInstancesForCats
  14. implicit def showConfigKeyType[K]: Show[ConfigKeyType[K]]
    Definition Classes
    CirisInstancesForCats
  15. implicit def showConfigValue[F[_], V]: Show[ConfigValue[F, V]]
    Definition Classes
    CirisInstancesForCats
  16. implicit def showSecret[A]: Show[Secret[A]]
    Definition Classes
    CirisInstancesForCats

Inherited from CirisInstancesForCats

Inherited from CatsInstancesForCiris

Inherited from CatsInstancesForCiris1

Inherited from CatsInstancesForCiris2

Inherited from CatsInstancesForCiris3

Inherited from CatsInstancesForCiris4

Inherited from CatsInstancesForCiris5

Inherited from AnyRef

Inherited from Any

Ungrouped