Packages

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}"""
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CirceCodecRefined
  2. AnyRef
  3. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  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[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. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. implicit final def refinedDecoder[T, P, F[_, _]](implicit underlying: Decoder[T], validate: Validate[T, P], refType: RefType[F]): Decoder[F[T, P]]
  16. implicit final def refinedEncoder[T, P, F[_, _]](implicit underlying: Encoder[T], refType: RefType[F]): Encoder[F[T, P]]
  17. implicit final def refinedKeyDecoder[T, P, F[_, _]](implicit underlying: KeyDecoder[T], validate: Validate[T, P], refType: RefType[F]): KeyDecoder[F[T, P]]
  18. implicit final def refinedKeyEncoder[T, P, F[_, _]](implicit underlying: KeyEncoder[T], refType: RefType[F]): KeyEncoder[F[T, P]]
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  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
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped