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 benchmark
    Definition Classes
    circe
  • package export
    Definition Classes
    circe
  • package generic
    Definition Classes
    circe
  • package hygiene
    Definition Classes
    circe
  • package jawn
    Definition Classes
    circe
  • package literal
    Definition Classes
    circe
  • package numbers
    Definition Classes
    circe
  • package pointer
    Definition Classes
    circe
  • package refined
    Definition Classes
    circe
  • CirceCodecRefined
  • package scalajs
    Definition Classes
    circe
  • package shapes
    Definition Classes
    circe
  • package syntax

    This package provides syntax via enrichment classes.

    This package provides syntax via enrichment classes.

    Definition Classes
    circe
  • package testing
    Definition Classes
    circe
p

io.circe

refined

package refined

Source
package.scala
Linear Supertypes
CirceCodecRefined, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. refined
  2. CirceCodecRefined
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait CirceCodecRefined extends AnyRef

    Provides codecs for refined types.

    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}"""

Value Members

  1. implicit final def refinedDecoder[T, P, F[_, _]](implicit underlying: Decoder[T], validate: Validate[T, P], refType: RefType[F]): Decoder[F[T, P]]
    Definition Classes
    CirceCodecRefined
  2. implicit final def refinedEncoder[T, P, F[_, _]](implicit underlying: Encoder[T], refType: RefType[F]): Encoder[F[T, P]]
    Definition Classes
    CirceCodecRefined
  3. implicit final def refinedKeyDecoder[T, P, F[_, _]](implicit underlying: KeyDecoder[T], validate: Validate[T, P], refType: RefType[F]): KeyDecoder[F[T, P]]
    Definition Classes
    CirceCodecRefined
  4. implicit final def refinedKeyEncoder[T, P, F[_, _]](implicit underlying: KeyEncoder[T], refType: RefType[F]): KeyEncoder[F[T, P]]
    Definition Classes
    CirceCodecRefined

Inherited from CirceCodecRefined

Inherited from AnyRef

Inherited from Any

Ungrouped