Packages

  • package root
    Definition Classes
    root
  • package scodec

    Combinator library for working with binary data.

    Combinator library for working with binary data.

    The primary abstraction of this library is Codec, which provides the ability to encode/decode values to/from binary.

    There are more general abstractions though, such as Encoder and Decoder. There's also GenCodec which extends both Encoder and Decoder but allows the types to vary. Given these more general abstractions, a Codec[A] can be represented as a GenCodec[A, A].

    The more general abstractions are important because they allow operations on codecs that would not otherwise be possible. For example, given a Codec[A], mapping a function A => B over the codec yields a GenCodec[A, B]. Without the more general abstractions, map is impossible to define (e.g., how would codec.map(f).encode(b) be implemented?). Given a GenCodec[A, B], the encoding functionality can be ignored by treating it as a Decoder[B], or the encoding type can be changed via contramap. If after further transformations, the two types to GenCodec are equal, we can reconstitute a Codec from the GenCodec by calling fuse.

    See the codecs package object for pre-defined codecs for many common data types and combinators for building larger codecs out of smaller ones.

    For the categorically minded, note the following:

    • Decoder is a monad
    • Encoder is a contravariant functor
    • GenCodec is a profunctor
    • Codec is an invariant functor
    Definition Classes
    root
  • package codecs

    Provides codecs for common types and combinators for building larger codecs.

    Provides codecs for common types and combinators for building larger codecs.

    Bits and Bytes Codecs

    The simplest of the provided codecs are those that encode/decode BitVectors and ByteVectors directly. These are provided by bits and bytes methods. These codecs encode all of the bits/bytes directly in to the result and decode *all* of the remaining bits/bytes in to the result value. That is, the result of decode always returns a empty bit vector for the remaining bits.

    Similarly, fixed size alternatives are provided by the bits(size) and bytes(size) methods, which encode a fixed number of bits/bytes (or error if not provided the correct size) and decoded a fixed number of bits/bytes (or error if that many bits/bytes are not available).

    There are more specialized codecs for working with bits, including ignore and constant.

    Numeric Codecs

    There are built-in codecs for Int, Long, Float, and Double.

    There are a number of predefined integral codecs named using the form: 

    [u]int$${size}[L]

    where u stands for unsigned, size is replaced by one of 8, 16, 24, 32, 64, and L stands for little-endian. For each codec of that form, the type is Codec[Int] or Codec[Long] depending on the specified size. For example, int32 supports 32-bit big-endian 2s complement signed integers, and uint16L supports 16-bit little-endian unsigned integers. Note: uint64[L] are not provided because a 64-bit unsigned integer does not fit in to a Long.

    Additionally, methods of the form [u]int[L](size: Int) and [u]long[L](size: Int) exist to build arbitrarily sized codecs, within the limitations of Int and Long.

    IEEE 754 floating point values are supported by the float, floatL, double, and doubleL codecs.

    Miscellaneous Value Codecs

    In addition to the numeric codecs, there are built-in codecs for Boolean, String, and UUID.

    Boolean values are supported by the bool codecs.

    Combinators

    There are a number of methods provided that create codecs out of other codecs. These include simple combinators such as fixedSizeBits and variableSizeBits and advanced combinators such as discriminated, which provides its own DSL for building a large codec out of many small codecs. For a list of all combinators, see the Combinators section below.

    Cryptography Codecs

    There are codecs that support working with encrypted data (encrypted), digital signatures and checksums (fixedSizeSignature and variableSizeSignature). Additionally, support for java.security.cert.Certificates is provided by certificate and x509Certificate.

    Definition Classes
    scodec
  • Attempt
  • BuildInfo
  • Codec
  • CodecTransformation
  • DecodeResult
  • Decoder
  • DecoderFunctions
  • DecodingContext
  • Encoder
  • EncoderFunctions
  • EnrichedCoproductDecoder
  • EnrichedCoproductEncoder
  • EnrichedHList
  • Err
  • GenCodec
  • HListCodecEnrichedWithHListSupport
  • SizeBound
  • Transform
  • TransformSyntax
  • Transformer
  • Tuple2CodecSupport
  • ValueCodecEnrichedWithGenericSupport
  • ValueCodecEnrichedWithHListSupport

object Codec extends EncoderFunctions with DecoderFunctions

Companion for Codec.

Source
Codec.scala
Linear Supertypes
DecoderFunctions, EncoderFunctions, AnyRef, Any
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
    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](implicit c: Lazy[Codec[A]]): Codec[A]

    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]

    Creates a codec from an encoder and a decoder.

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

    Creates a codec from encoder and decoder functions.

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

    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]

    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
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. def coproduct[A](implicit auto: CoproductBuilderAuto[A]): Out

    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]]

    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)

    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)]]

    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]]

    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: scala.collection.compat.Factory[A, F[A]]): Attempt[DecodeResult[F[A]]]

    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]

    Supports derived codecs.

  18. implicit val deriveHNil: Codec[HNil]

    Supports derived codecs.

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

    Supports derived codecs.

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

    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]]

    Supports derived codecs.

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

    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]

    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]

    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
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def lazily[A](codec: ⇒ Codec[A]): Codec[A]

    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
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. implicit val transformInstance: Transform[Codec]

    Transform typeclass instance.

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

Inherited from DecoderFunctions

Inherited from EncoderFunctions

Inherited from AnyRef

Inherited from Any

Constructors

Conveniences

Supporting Instances

Ungrouped