Packages

sealed abstract class Codec[A] extends AnyRef

Provides a schema, along with encoding and decoding functions for a given type.

Annotations
@implicitNotFound("could not find implicit Codec[${A}]; ensure no imports are missing or manually define an instance")
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Codec
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decode(value: Any, schema: Schema): Either[AvroError, A]

    Attempts to decode the specified value using the provided schema.

  2. abstract def encode(a: A, schema: Schema): Either[AvroError, Any]

    Attempts to encode the specified value using the provided schema.

  3. abstract def schema: Either[AvroError, Schema]

    The schema or an error if the schema could not be generated.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def imap[B](f: (A) => B)(g: (B) => A): Codec[B]

    Returns a new Codec which uses this Codec for encoding and decoding, mapping back-and-forth between types A and B.

  12. final def imapError[B](f: (A) => Either[AvroError, B])(g: (B) => A): Codec[B]

    Returns a new Codec which uses this Codec for encoding and decoding, mapping back-and-forth between types A and B.

    Returns a new Codec which uses this Codec for encoding and decoding, mapping back-and-forth between types A and B.

    Similar to Codec#imap, except the mapping from A to B might be unsuccessful.

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped