Packages

t

org.virtuslab.ash.circe

CirceTraitCodec

trait CirceTraitCodec[Ser <: AnyRef] extends Codec[Ser]

Linear Supertypes
Codec[Ser], Encoder[Ser], Decoder[Ser], Serializable, AnyRef, Any
Known Subclasses
CirceAkkaSerializer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CirceTraitCodec
  2. Codec
  3. Encoder
  4. Decoder
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. implicit abstract val classTagEvidence: ClassTag[Ser]
  2. abstract val codecs: Seq[Registration[_ <: Ser]]

    Sequence that must contain org.virtuslab.ash.circe.Registration for all direct subclasses of Ser.

    Sequence that must contain org.virtuslab.ash.circe.Registration for all direct subclasses of Ser.

    Each Registration is created using org.virtuslab.ash.circe.Registers org.virtuslab.ash.circe.Register#apply method.

    To check if all needed classes are registered, use Codec Registration Checker.

    See also

    org.virtuslab.ash.circe.Registerorg.virtuslab.ash.circe.Register#apply for more information about type derivation

  3. abstract val errorCallback: (String) => Unit
  4. abstract val manifestMigrations: Seq[(String, Class[_])]

    A sequence containing information used in type migration.

    A sequence containing information used in type migration.

    If you ever change the name of a class that is a direct descendant of Ser and is persisted in any way, you must append new pair to this field.

    • The first element of the pair is a String with the value of old FQCN.
    • The second element of the pair is a Class that had its name changed

    Example:

    override lazy val manifestMigrations = Seq(
 "app.OldName" -> classOf[app.NewName]
)
  5. abstract val packagePrefix: String

    Package prefix of your project.

    Package prefix of your project. Ensure that Ser is included in that package and as many classes that extend it.

    It should look something like "org.group.project"

    It is used for some runtime checks that are executed at the end of constructor.

Concrete 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. def apply(a: Ser): Json

    Encoder apply method - encodes given object of type Ser into Json

    Encoder apply method - encodes given object of type Ser into Json

    Definition Classes
    CirceTraitCodec → Encoder
  5. def apply(c: HCursor): Result[Ser]

    Decoder apply method - decodes from Json into an object of type Ser

    Decoder apply method - decodes from Json into an object of type Ser

    Definition Classes
    CirceTraitCodec → Decoder
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def at(field: String): Decoder[Ser]
    Definition Classes
    Decoder
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val codecsMap: Map[String, (Encoder[_ <: Ser], Decoder[_ <: Ser])]
    Attributes
    protected
  10. final def contramap[B](f: (B) => Ser): Encoder[B]
    Definition Classes
    Encoder
  11. def decodeAccumulating(c: HCursor): AccumulatingResult[Ser]
    Definition Classes
    Decoder
  12. final def decodeJson(j: Json): Result[Ser]
    Definition Classes
    Decoder
  13. final def either[B](decodeB: Decoder[B]): Decoder[Either[Ser, B]]
    Definition Classes
    Decoder
  14. final def emap[B](f: (Ser) => Either[String, B]): Decoder[B]
    Definition Classes
    Decoder
  15. final def emapTry[B](f: (Ser) => Try[B]): Decoder[B]
    Definition Classes
    Decoder
  16. final def ensure(errors: (Ser) => List[String]): Decoder[Ser]
    Definition Classes
    Decoder
  17. final def ensure(pred: (Ser) => Boolean, message: => String): Decoder[Ser]
    Definition Classes
    Decoder
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. final def flatMap[B](f: (Ser) => Decoder[B]): Decoder[B]
    Definition Classes
    Decoder
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def handleErrorWith(f: (DecodingFailure) => Decoder[Ser]): Decoder[Ser]
    Definition Classes
    Decoder
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def iemap[B](f: (Ser) => Either[String, B])(g: (B) => Ser): Codec[B]
    Definition Classes
    Codec
  25. def iemapTry[B](f: (Ser) => Try[B])(g: (B) => Ser): Codec[B]
    Definition Classes
    Codec
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def kleisli: Kleisli[Result, HCursor, Ser]
    Definition Classes
    Decoder
  28. def manifest(o: AnyRef): String
  29. val manifestMigrationsMap: Map[String, String]
    Attributes
    protected
  30. final def map[B](f: (Ser) => B): Decoder[B]
    Definition Classes
    Decoder
  31. final def mapJson(f: (Json) => Json): Encoder[Ser]
    Definition Classes
    Encoder
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. final def or[AA >: Ser](d: => Decoder[AA]): Decoder[AA]
    Definition Classes
    Decoder
  36. final def prepare(f: (ACursor) => ACursor): Decoder[Ser]
    Definition Classes
    Decoder
  37. final def product[B](fb: Decoder[B]): Decoder[(Ser, B)]
    Definition Classes
    Decoder
  38. lazy val shouldDoMissingCodecsCheck: Boolean
    Attributes
    protected
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. def tryDecode(c: ACursor): Result[Ser]
    Definition Classes
    Decoder
  42. def tryDecodeAccumulating(c: ACursor): AccumulatingResult[Ser]
    Definition Classes
    Decoder
  43. final def validate(pred: (HCursor) => Boolean, message: => String): Decoder[Ser]
    Definition Classes
    Decoder
  44. final def validate(errors: (HCursor) => List[String]): Decoder[Ser]
    Definition Classes
    Decoder
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def withErrorMessage(message: String): Decoder[Ser]
    Definition Classes
    Decoder

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Codec[Ser]

Inherited from Encoder[Ser]

Inherited from Decoder[Ser]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped