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
  • object Err

    Companion for Err.

    Companion for Err.

    Definition Classes
    scodec
  • Composite
  • General
  • InsufficientBits
  • MatchingDiscriminatorNotFound
c

scodec.Err

Composite

final case class Composite(errs: List[Err], context: List[String]) extends Err with Product with Serializable

Source
Err.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Err, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Composite
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Err
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Composite(errs: List[Err])
  2. new Composite(errs: List[Err], context: List[String])

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. val context: List[String]

    Gets a stack of context identifiers.

    Gets a stack of context identifiers.

    The head of the list is the outermost (i.e., least specific) identifier.

    Definition Classes
    Composite → Err
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val errs: List[Err]
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def message: String

    Gets a description of the error.

    Gets a description of the error.

    Definition Classes
    Composite → Err
  13. 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
  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. def push(err: Err): Composite
  18. def pushContext(ctx: String): Err

    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
    Composite → Err
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    Err → AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Err

Inherited from AnyRef

Inherited from Any

Ungrouped