Packages

object Codec

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

Type Members

  1. sealed abstract class Alt[A] extends AnyRef

  2. sealed abstract class AltBuilder[A] extends AnyRef

  3. sealed abstract class Field[A, B] extends AnyRef

  4. sealed abstract class FieldBuilder[A] extends AnyRef

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 apply[A](implicit codec: Codec[A]): Codec[A]

    Returns the Codec for the specified type.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. implicit final val boolean: Codec[Boolean]

  7. implicit final val byte: Codec[Byte]

  8. implicit final val bytes: Codec[Array[Byte]]

  9. implicit final def chain[A](implicit codec: Codec[A]): Codec[Chain[A]]

  10. implicit final val char: Codec[Char]

  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. implicit final val codecInvariant: Invariant[Codec]

  13. implicit final def codecShow[A]: Show[Codec[A]]

  14. final def decimal(precision: Int, scale: Int): Codec[BigDecimal]

    Returns a new decimal Codec for type BigDecimal.

  15. final def decode[A](value: Any)(implicit codec: Codec[A]): Either[AvroError, A]

    Returns the result of decoding the specified value to the specified type.

  16. final def deriveEnum[A](symbols: Seq[String], encode: (A) => String, decode: (String) => Either[AvroError, A])(implicit tag: scala.reflect.api.JavaUniverse.WeakTypeTag[A]): Codec[A]

    Returns an enum Codec for type A, deriving details like the name, namespace, and AvroDoc documentation from the type A using type tags.

  17. final def deriveFixed[A](size: Int, encode: (A) => Array[Byte], decode: (Array[Byte]) => Either[AvroError, A])(implicit tag: scala.reflect.api.JavaUniverse.WeakTypeTag[A]): Codec[A]

    Returns a fixed Codec for type A, deriving details like the name, namespace, and AvroDoc documentation from the type A using type tags.

  18. implicit final val double: Codec[Double]

  19. final def encode[A](a: A)(implicit codec: Codec[A]): Either[AvroError, Any]

    Returns the result of encoding the specified value.

  20. final def enum[A](name: String, symbols: Seq[String], encode: (A) => String, decode: (String) => Either[AvroError, A], namespace: Option[String] = None, aliases: Seq[String] = Seq.empty, doc: Option[String] = None, default: Option[A] = None, props: Props = Props.empty): Codec[A]

    Returns a new enum Codec for type A.

  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  24. final def fixed[A](name: String, size: Int, encode: (A) => Array[Byte], decode: (Array[Byte]) => Either[AvroError, A], namespace: Option[String] = None, aliases: Seq[String] = Seq.empty, doc: Option[String] = None, props: Props = Props.empty): Codec[A]

    Returns a new fixed Codec for type A.

    Returns a new fixed Codec for type A.

    When encoding, bytes are zero-padded to the specified size. Zero-padding is applied at the end, and will remain in the input to decode. Encoding checks to ensure the size is not exceeded, while decoding ensures the exact size.

  25. implicit final val float: Codec[Float]

  26. final def fromBinary[A](bytes: Array[Byte])(implicit codec: Codec[A]): Either[AvroError, A]

    Returns the result of decoding the specified Avro binary to the specified type.

  27. final def fromJson[A](json: String)(implicit codec: Codec[A]): Either[AvroError, A]

    Returns the result of decoding the specified Avro JSON to the specified type.

  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. final def instance[A](schema: Either[AvroError, Schema], encode: (A, Schema) => Either[AvroError, Any], decode: (Any, Schema) => Either[AvroError, A]): Codec[A]

    Returns a new Codec instance using the specified Schema, and encode and decode functions.

  31. implicit final val instant: Codec[Instant]

  32. implicit final val int: Codec[Int]

  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. implicit final def list[A](implicit codec: Codec[A]): Codec[List[A]]

  35. implicit final val localDate: Codec[LocalDate]

  36. implicit final val long: Codec[Long]

  37. implicit final def map[A](implicit codec: Codec[A]): Codec[Map[String, A]]

  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. implicit final def nonEmptyChain[A](implicit codec: Codec[A]): Codec[NonEmptyChain[A]]

  40. implicit final def nonEmptyList[A](implicit codec: Codec[A]): Codec[NonEmptyList[A]]

  41. implicit final def nonEmptySet[A](implicit codec: Codec[A], ordering: Ordering[A]): Codec[NonEmptySet[A]]

  42. implicit final def nonEmptyVector[A](implicit codec: Codec[A]): Codec[NonEmptyVector[A]]

  43. implicit final val none: Codec[None.type]

  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. implicit final def option[A](implicit codec: Codec[A]): Codec[Option[A]]

  47. final def record[A](name: String, namespace: Option[String] = None, doc: Option[String] = None, aliases: Seq[String] = Seq.empty, props: Props = Props.empty)(f: (FieldBuilder[A]) => FreeApplicative[[β$0$]Field[A, β$0$], A]): Codec[A]

    Returns a new record Codec for type A.

  48. implicit final def seq[A](implicit codec: Codec[A]): Codec[Seq[A]]

  49. implicit final def set[A](implicit codec: Codec[A]): Codec[Set[A]]

  50. implicit final val short: Codec[Short]

  51. implicit final def some[A](implicit codec: Codec[A]): Codec[Some[A]]

  52. implicit final val string: Codec[String]

  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. final def toBinary[A](a: A)(implicit codec: Codec[A]): Either[AvroError, Array[Byte]]

    Returns the result of encoding the specified value to Avro binary.

  55. final def toJson[A](a: A)(implicit codec: Codec[A]): Either[AvroError, String]

    Returns the result of encoding the specified value to Avro JSON.

  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. final def union[A](f: (AltBuilder[A]) => Chain[Alt[A]])(implicit tag: scala.reflect.api.JavaUniverse.WeakTypeTag[A]): Codec[A]

    Returns a new union Codec for type A.

  58. implicit final val unit: Codec[Unit]

  59. implicit final val uuid: Codec[UUID]

  60. implicit final def vector[A](implicit codec: Codec[A]): Codec[Vector[A]]

  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

General Codecs

Default codecs for standard library types.

Collection Codecs

Default codecs for standard library collection types.

Cats Codecs

Default codecs for Cats data types and type class instances for Codec.

Java Time Codecs

Default codecs for java.time types.

Java Util Codecs

Default codecs for java.util types.

Create Codecs

Functions for creating new codecs.

Derive Codecs

Functions for deriving new codecs.

Utilities

Miscellaneous utility functions.

Ungrouped