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
  • trait KnownDiscriminatorType [D] extends AnyRef

    Mixin for codecs/decoders that are known to discriminate by values of type D.

    Mixin for codecs/decoders that are known to discriminate by values of type D.

    Definition Classes
    codecs
  • UnknownDiscriminator
c

scodec.codecs.KnownDiscriminatorType

UnknownDiscriminator

case class UnknownDiscriminator(discriminator: D, context: List[String]) extends Err with Product with Serializable

Error raised when an unknown discriminator is encountered when decoding.

Source
KnownDiscriminatorType.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Err, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnknownDiscriminator
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Err
  7. AnyRef
  8. Any
Implicitly
  1. by ValueEnrichedWithTuplingSupport
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UnknownDiscriminator(discriminator: D)
  2. new UnknownDiscriminator(discriminator: D, context: List[String])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to any2stringadd[UnknownDiscriminator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (UnknownDiscriminator, B)
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to ArrowAssoc[UnknownDiscriminator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val a: UnknownDiscriminator
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to ValueEnrichedWithTuplingSupport[UnknownDiscriminator] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val context: List[String]
    Definition Classes
    UnknownDiscriminator → Err
  10. val discriminator: D
  11. def ensuring(cond: (UnknownDiscriminator) ⇒ Boolean, msg: ⇒ Any): UnknownDiscriminator
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to Ensuring[UnknownDiscriminator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (UnknownDiscriminator) ⇒ Boolean): UnknownDiscriminator
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to Ensuring[UnknownDiscriminator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): UnknownDiscriminator
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to Ensuring[UnknownDiscriminator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): UnknownDiscriminator
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to Ensuring[UnknownDiscriminator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to StringFormat[UnknownDiscriminator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def message: String

    Gets a description of the error.

    Gets a description of the error.

    Definition Classes
    UnknownDiscriminator → Err
  21. def messageWithContext: String

    Gets a description of the error with the context identifiers prefixing the message.

    Gets a description of the error with the context identifiers prefixing the message.

    Definition Classes
    Err
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  25. def pushContext(ctx: String): UnknownDiscriminator

    Returns a new error with the specified context identifier pushed in to the context stack.

    Returns a new error with the specified context identifier pushed in to the context stack.

    Definition Classes
    UnknownDiscriminator → Err
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Err → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def ~[B](b: B): (UnknownDiscriminator, B)
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to ValueEnrichedWithTuplingSupport[UnknownDiscriminator] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport
  32. def →[B](y: B): (UnknownDiscriminator, B)
    Implicit
    This member is added by an implicit conversion from UnknownDiscriminator to ArrowAssoc[UnknownDiscriminator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Err

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion ValueEnrichedWithTuplingSupport from UnknownDiscriminator to ValueEnrichedWithTuplingSupport[UnknownDiscriminator]

Inherited by implicit conversion any2stringadd from UnknownDiscriminator to any2stringadd[UnknownDiscriminator]

Inherited by implicit conversion StringFormat from UnknownDiscriminator to StringFormat[UnknownDiscriminator]

Inherited by implicit conversion Ensuring from UnknownDiscriminator to Ensuring[UnknownDiscriminator]

Inherited by implicit conversion ArrowAssoc from UnknownDiscriminator to ArrowAssoc[UnknownDiscriminator]

Ungrouped