Type Members

1.  trait AdtDecoder[T] extends Decoder[T]

   An AdtDecoder is a Decoder whose read method expects to read an envelope (holding the type id) around the actual value encoding.

   An AdtDecoder is a Decoder whose read method expects to read an envelope (holding the type id) around the actual value encoding.

   In order to be able to collapse several envelope levels into a single one, when several AdtDecoder instances call each other, this type also provides read overloads which don't read the type id envelope themselves but can receive the type id from the outside.

2.  trait AdtEncoder[T] extends Encoder[T]

   An AdtEncoder is an Encoder which encodes its values with an envelope holding the value's type id.

   An AdtEncoder is an Encoder which encodes its values with an envelope holding the value's type id.

   It doesn't change or add to the outside interface of Encoder but merely serves as a marker signaling that it takes on the responsibility of encoding the type id in addition to the value itself. This allows outside encoders calling an AdtEncoder to delegate this responsibility rather than performing the task themselves.

3.  sealed abstract class AdtEncodingStrategy extends AnyRef
4.  trait ByteAccess[Bytes] extends AnyRef

   Type class for providing basic access to a Bytes abstraction, as well as construction of a respective Output.

5.  final class ByteStringArrayCodecs extends AnyRef
6.  final case class Codec[A](encoder: Encoder[A], decoder: Decoder[A]) extends Product with Serializable

   A simple encapsulation of an Encoder and Decoder for the same type, as one entity.

   A simple encapsulation of an Encoder and Decoder for the same type, as one entity.

   Sometimes it's easier to supply just a single implicit for a type, rather than two. As an alternative to writing a separate Encoder and Decoder for type A you can also write a Codec for A. (Encoder and Decoder can be implicitly "unpacked" from a codec.)

   However, in order to not hinder composability Codecs should only ever be _supplied_, never consumed. So, if you write an encoder, decoder or codec for a generic type, which itself requires implicitly available encoders and/or decoders for certain type parameters (like Encoder.forOption, for example) then you should never require implicitly available Codecs, but rather Encoders and Decoders separately.

7.  trait Decoder[T] extends AnyRef

   Type class responsible for reading an instance of type T from a Reader.

8.  abstract class DecoderFromApply extends AnyRef
9.  final case class Default[+T](defaultValue: T) extends Product with Serializable
10.  trait Encoder[T] extends AnyRef

    Type class responsible for writing an instance of type T to a Writer.

11.  final case class Float16(value: Float) extends Product with Serializable

    Wrapper for Float value that gets encoded to and decoded from 16-bit Half-Precision Floats (two-byte IEEE 754).

12.  trait Input[Bytes] extends AnyRef

    Mutable abstraction wrapping some source of bytes to serve as parser input.

13.  final class InputReader[Config <: Config] extends AnyRef

    Stateful, mutable abstraction for reading a stream of CBOR or JSON data from the given input.

14.  sealed abstract class LowPrioDecoders extends TupleDecoders
15.  sealed abstract class LowPrioEncoders extends TupleEncoders
16.  sealed abstract class LowPrioNullable extends AnyRef
17.  final class Nullable[+T] extends AnyVal
18.  trait Output extends AnyRef

    Abstraction over serialization output.

    Abstraction over serialization output.

    The implementation can be either mutable or immutable.

19.  type Reader = InputReader[_ <: Config]
20.  abstract class Receiver extends AnyRef

    The common interface of all types that consume CBOR data.

    The common interface of all types that consume CBOR data. (On the reading as well as the writing side)

21.  final case class SimpleValue(value: Int) extends Product with Serializable

    Abstraction for a "simple value" in CBOR-speak.

    Abstraction for a "simple value" in CBOR-speak.

    value

    the value's code

22.  sealed abstract class Tag extends AnyRef

    Abstraction for a "tag" in CBOR-speak.

23.  final case class TaggedValue[T](tag: Tag, value: T) extends Product with Serializable
24.  sealed abstract class Target extends AnyRef

    Super-type of the Cbor and Json objects.

    Super-type of the Cbor and Json objects.

    Used, for example, as the type of the target member of Reader and Writer instances, which allows custom logic to pick different (de)serialization approaches depending on whether the target is CBOR or JSON.

25.  abstract class TupleDecoders extends DecoderFromApply
26.  abstract class TupleEncoders extends AnyRef
27.  final class Writer extends AnyRef

    Stateful, mutable abstraction for writing a stream of CBOR or JSON data to the given Output.