Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package circe

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    Overview

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    The library is divided into a number of modules that either provide core functionality, support additional features via third-party dependencies, or facilitate integration with other libraries or frameworks.

    • numbers: core facilities for representing and parsing JSON numbers.
    • core: our JSON abstract syntax tree, our zipper-like cursor types, and our encoding and decoding type classes (and instances).
    • parser: JSON parsing support for both the Java Virtual Machine (using Jawn) and Scala.js (using the native JavaScript JSON parser).
    • testing: ScalaCheck Arbitrary instances for circe's JSON AST and other types, as well as other useful testing tools.
    • literal: JSON string interpolation and encoder and decoder instances for literal types.
    • generic: Shapeless-powered generic derivation for case classes and sealed trait hierarchies.
    • generic-extras: additional experimental generic derivation functionality (including some configurability).
    • pointer: A JSON Pointer implementation
    • pointer-literal: JSON Pointer string interpolation
    • shapes: encoders and decoders for Shapeless hlists, coproducts, records, and sized collections.
    • scodec: encoders and decoders for Scodec's BitVector and ByteVector.
    • refined: encoders and decoders for refined types.
    • spray: Spray marshaller conversions for Circe's type classes.

    Please refer to the documentation for a more detailed introduction to the library.

    Definition Classes
    io
  • package refined
    Definition Classes
    circe
  • CirceCodecRefined
t

io.circe.refined

CirceCodecRefined

trait CirceCodecRefined extends AnyRef

Provides codecs for refined types.

A refined type T Refined Predicate is encoded as T. Decoding ensures that the decoded value satisfies Predicate.

E.g. with generic codecs

case class Obj(
  i: Int Refined Positive
)

Obj(refineMV(4)).asJson.noSpaces == """{"i":4}"""
Source
CirceCodecRefined.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CirceCodecRefined
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from CirceCodecRefined toany2stringadd[CirceCodecRefined] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CirceCodecRefined, B)
    Implicit
    This member is added by an implicit conversion from CirceCodecRefined toArrowAssoc[CirceCodecRefined] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (CirceCodecRefined) => Boolean, msg: => Any): CirceCodecRefined
    Implicit
    This member is added by an implicit conversion from CirceCodecRefined toEnsuring[CirceCodecRefined] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (CirceCodecRefined) => Boolean): CirceCodecRefined
    Implicit
    This member is added by an implicit conversion from CirceCodecRefined toEnsuring[CirceCodecRefined] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): CirceCodecRefined
    Implicit
    This member is added by an implicit conversion from CirceCodecRefined toEnsuring[CirceCodecRefined] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): CirceCodecRefined
    Implicit
    This member is added by an implicit conversion from CirceCodecRefined toEnsuring[CirceCodecRefined] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from CirceCodecRefined toStringFormat[CirceCodecRefined] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. implicit final def refinedDecoder[T, P, F[_, _]](implicit underlying: Decoder[T], validate: Validate[T, P], refType: RefType[F]): Decoder[F[T, P]]
  23. implicit final def refinedEncoder[T, P, F[_, _]](implicit underlying: Encoder[T], refType: RefType[F]): Encoder[F[T, P]]
  24. implicit final def refinedKeyDecoder[T, P, F[_, _]](implicit underlying: KeyDecoder[T], validate: Validate[T, P], refType: RefType[F]): KeyDecoder[F[T, P]]
  25. implicit final def refinedKeyEncoder[T, P, F[_, _]](implicit underlying: KeyEncoder[T], refType: RefType[F]): KeyEncoder[F[T, P]]
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (CirceCodecRefined, B)
    Implicit
    This member is added by an implicit conversion from CirceCodecRefined toArrowAssoc[CirceCodecRefined] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromCirceCodecRefined to any2stringadd[CirceCodecRefined]

Inherited by implicit conversion StringFormat fromCirceCodecRefined to StringFormat[CirceCodecRefined]

Inherited by implicit conversion Ensuring fromCirceCodecRefined to Ensuring[CirceCodecRefined]

Inherited by implicit conversion ArrowAssoc fromCirceCodecRefined to ArrowAssoc[CirceCodecRefined]

Ungrouped