Object/Trait

scodec

Codec

Related Docs: trait Codec | package scodec

Permalink

object Codec extends EncoderFunctions with DecoderFunctions

Companion for Codec.

Source
Codec.scala
Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Codec
  2. DecoderFunctions
  3. EncoderFunctions
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply[A](implicit c: Lazy[Codec[A]]): Codec[A]

    Permalink

    Gets an implicitly available codec for type A.

    Gets an implicitly available codec for type A.

    If an implicit Codec[A] is not available, one might be able to be derived automatically. Codecs can be derived for:

    • case classes (and hlists and records), where each component type of the case class either has an implicitly available codec or one can be automatically derived
    • sealed class hierarchies (and coproducts and unions), where:
      • the root type, A, has an implicitly available Discriminated[A, D] for some D
      • each subtype has an implicitly available codec or can have one derived
      • each subtype X has an implicitly available Discriminator[A, X, D]
  5. def apply[A](encoder: Encoder[A], decoder: Decoder[A]): Codec[A]

    Permalink

    Creates a codec from an encoder and a decoder.

  6. def apply[A](encoder: (A) ⇒ Attempt[BitVector], decoder: (BitVector) ⇒ Attempt[DecodeResult[A]]): Codec[A]

    Permalink

    Creates a codec from encoder and decoder functions.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. final def choiceDecoder[A](decoders: Decoder[A]*): Decoder[A]

    Permalink

    Creates a decoder that decodes with each of the specified decoders, returning the first successful result.

    Creates a decoder that decodes with each of the specified decoders, returning the first successful result.

    Definition Classes
    DecoderFunctions
  9. final def choiceEncoder[A](encoders: Encoder[A]*): Encoder[A]

    Permalink

    Creates an encoder that encodes with each of the specified encoders, returning the first successful result.

    Creates an encoder that encodes with each of the specified encoders, returning the first successful result.

    Definition Classes
    EncoderFunctions
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def coproduct[A](implicit auto: CoproductBuilderAuto[A]): Out

    Permalink

    Creates a coproduct codec builder for the specified type.

    Creates a coproduct codec builder for the specified type.

    Support exists for coproducts and unions. Each component type must have an implicitly available codec.

    For example:

    type C = Foo :+: Bar :+: Baz :+: CNil
    val codec = Codec.coproduct[C].choice
    codec.encode(Coproduct[C](Foo(...)))
  12. def decode[A](bits: BitVector)(implicit c: Lazy[Codec[A]]): Attempt[DecodeResult[A]]

    Permalink

    Decodes the specified bit vector in to a value of type A using an implicitly available codec.

  13. final def decodeAll[A, B](buffer: BitVector)(zero: B, append: (B, B) ⇒ B)(f: (A) ⇒ B)(implicit decoder: Lazy[Decoder[A]]): (Option[Err], B)

    Permalink

    Repeatedly decodes values of type A from the specified vector, converts each value to a B and appends it to an accumulator of type B using the supplied zero value and append function.

    Repeatedly decodes values of type A from the specified vector, converts each value to a B and appends it to an accumulator of type B using the supplied zero value and append function. Terminates when no more bits are available in the vector. Exits upon first decoding error.

    returns

    tuple consisting of the terminating error if any and the accumulated value

    Definition Classes
    DecoderFunctions
  14. final def decodeBoth[A, B](decA: Decoder[A], decB: Decoder[B])(buffer: BitVector): Attempt[DecodeResult[(A, B)]]

    Permalink

    Decodes a tuple (A, B) by first decoding A and then using the remaining bits to decode B.

    Decodes a tuple (A, B) by first decoding A and then using the remaining bits to decode B.

    Definition Classes
    DecoderFunctions
  15. final def decodeBothCombine[A, B, C](decA: Decoder[A], decB: Decoder[B])(buffer: BitVector)(f: (A, B) ⇒ C): Attempt[DecodeResult[C]]

    Permalink

    Decodes a C by first decoding A and then using the remaining bits to decode B, then applying the decoded values to the specified function to generate a C.

    Decodes a C by first decoding A and then using the remaining bits to decode B, then applying the decoded values to the specified function to generate a C.

    Definition Classes
    DecoderFunctions
  16. final def decodeCollect[F[_], A](dec: Decoder[A], limit: Option[Int])(buffer: BitVector)(implicit cbf: CanBuildFrom[F[A], A, F[A]]): Attempt[DecodeResult[F[A]]]

    Permalink

    Repeatedly decodes values of type A from the specified vector and returns a collection of the specified type.

    Repeatedly decodes values of type A from the specified vector and returns a collection of the specified type. Terminates when no more bits are available in the vector or when limit is defined and that many records have been decoded. Exits upon first decoding error.

    Definition Classes
    DecoderFunctions
  17. implicit def deriveCoproduct[A, D, C0 <: Coproduct](implicit discriminated: Discriminated[A, D], auto: CoproductBuilderAuto[A] { type C = C0 }, auto2: CoproductBuilderAutoDiscriminators[A, C0, D]): Codec[A]

    Permalink

    Supports derived codecs.

  18. implicit val deriveHNil: Codec[HNil]

    Permalink

    Supports derived codecs.

  19. implicit def deriveLabelledGeneric[A, Rec <: HList](implicit lgen: Aux[A, Rec], auto: Lazy[Codec[Rec]]): Codec[A]

    Permalink

    Supports derived codecs.

  20. implicit def deriveProduct[H, T <: HList](implicit headCodec: Lazy[Codec[H]], tailAux: Lazy[Codec[T]]): Codec[::[H, T]]

    Permalink

    Supports derived codecs.

  21. implicit def deriveRecord[KH <: Symbol, VH, TRec <: HList, KT <: HList](implicit keys: Aux[::[FieldType[KH, VH], TRec], ::[KH, KT]], headCodec: Lazy[Codec[VH]], tailAux: Lazy[Codec[TRec]]): Codec[::[FieldType[KH, VH], TRec]]

    Permalink

    Supports derived codecs.

  22. def encode[A](a: A)(implicit c: Lazy[Codec[A]]): Attempt[BitVector]

    Permalink

    Encodes the specified value to a bit vector using an implicitly available codec.

  23. final def encodeBoth[A, B](encA: Encoder[A], encB: Encoder[B])(a: A, b: B): Attempt[BitVector]

    Permalink

    Encodes the specified values, one after the other, to a bit vector using the specified encoders.

    Encodes the specified values, one after the other, to a bit vector using the specified encoders.

    Definition Classes
    EncoderFunctions
  24. final def encodeSeq[A](enc: Encoder[A])(seq: Seq[A]): Attempt[BitVector]

    Permalink

    Encodes all elements of the specified sequence and concatenates the results, or returns the first encountered error.

    Encodes all elements of the specified sequence and concatenates the results, or returns the first encountered error.

    Definition Classes
    EncoderFunctions
  25. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  27. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  31. def lazily[A](codec: ⇒ Codec[A]): Codec[A]

    Permalink

    Provides a Codec[A] that delegates to a lazily evaluated Codec[A].

    Provides a Codec[A] that delegates to a lazily evaluated Codec[A]. Typically used to consruct codecs for recursive structures.

  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  37. implicit val transformInstance: Transform[Codec]

    Permalink

    Transform typeclass instance.

  38. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from DecoderFunctions

Inherited from EncoderFunctions

Inherited from AnyRef

Inherited from Any

Constructors

Conveniences

Supporting Instances

Ungrouped