Codec

Supports encoding a value of type A to a BitVector and decoding a BitVector to a value of A.

Not every value of A can be encoded to a bit vector and similarly, not every bit vector can be decoded to a value of type A. Hence, both encode and decode return either an error or the result. Furthermore, decode returns the remaining bits in the bit vector that it did not use in decoding.

Note: the decode function can be lifted to a state action via StateT[Error \/ ?, BitVector, A]. This type alias and associated constructor is provided by Codec.DecodingContext.

Linear Supertypes

AnyRef, Any

Known Subclasses

BitVectorCodec, BooleanCodec, CertificateCodec, CipherCodec, ConditionalCodec, ConstantCodec, FixedSizeCodec, IdentityCodec, IgnoreCodec, IndexedSeqCodec, IntCodec, LongCodec, NamedCodec, SignatureCodec, StringCodec, TupleCodec, UuidCodec, VariableSizeCodec

Abstract Value Members

abstract def decode(bits: BitVector): \/[Error, (BitVector, A)]

Attempts to decode a value of type A from the specified bit vector.
abstract def encode(a: A): \/[Error, BitVector]

Attempts to encode the specified value in to a bit vector.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def >>~[B](f: (A) ⇒ Codec[B]): Codec[(A, B)]

Operator alias for flatZip.
final def as[B](implicit iso: Iso[B, A]): Codec[B]

Returns a new codec that encodes/decodes a value of type B by using an iso between A and B.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def flatZip[B](f: (A) ⇒ Codec[B]): Codec[(A, B)]

Returns a new codec that encodes/decodes a value of type (A, B) where the codec of B is dependent on A.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def hlist: Codec[::[A, HNil]]

Lifts this codec in to a codec of a singleton hlist, which allows easy binding to case classes of one argument.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws()
final def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): Codec[B]

Maps to a codec of type B.

trait Codec[A] extends AnyRef

Abstract Value Members

abstract def decode(bits: BitVector): \/[Error, (BitVector, A)]

abstract def encode(a: A): \/[Error, BitVector]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def >>~[B](f: (A) ⇒ Codec[B]): Codec[(A, B)]

final def as[B](implicit iso: Iso[B, A]): Codec[B]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def flatZip[B](f: (A) ⇒ Codec[B]): Codec[(A, B)]

final def getClass(): Class[_]

def hashCode(): Int

final def hlist: Codec[::[A, HNil]]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): Codec[B]

Inherited from AnyRef

Inherited from Any

Ungrouped