ByteOrderMagic

Attempts to decode a value of type A from the specified bit vector.

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

Provides a bound on the size of successfully encoded values.

Assuming B is Unit, creates a Codec[A] that: encodes the A followed by a unit; decodes an A followed by a unit and discards the decoded unit.

Operator alias of dropRight.

Returns a new codec that encodes/decodes a value of type (A, B) where the codec of B is dependent on A. Operator alias for flatZip.

Transforms this codec to a Codec[B] if A is isomorphic to B.

This is most commonly used to convert a tuple codec to a case class:

Gets this as a Decoder.

Gets this as an Encoder.

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.

Converts this encoder to a new encoder that compacts the generated bit vector before returning it

Converts this decoder to a new decoder that fails decoding if there are remaining bits.

Similar to flatZip except the A type is not visible in the resulting type -- the binary effects of the Codec[A] still occur though.

Example usage:

   case class Flags(x: Boolean, y: Boolean, z: Boolean)
   (bool :: bool :: bool :: ignore(5)).consume { flgs =>
     conditional(flgs.x, uint8) :: conditional(flgs.y, uint8) :: conditional(flgs.z, uint8)
   } {
     case (x, y, z) => Flags(x.isDefined, y.isDefined, z.isDefined) }
   }

Converts this encoder to an Encoder[B] using the supplied B => A.

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.

Converts this to a codec that fails encoding with an error.

Attempts to decode a value of type A from the specified bit vector and discards the remaining bits.

Safely lifts this codec to a codec of a subtype.

When a supertype of B that is not a supertype of A is decoded, an decoding error is returned.

Assuming A is Unit, creates a Codec[B] that: encodes the unit followed by a B; decodes a unit followed by a B and discards the decoded unit.

Assuming B is Unit, creates a Codec[A] that: encodes the A followed by a unit; decodes an A followed by a unit and discards the decoded unit.

Converts this encoder to an Encoder[B] using the supplied B => Attempt[A].

Converts this decoder to a Decoder[B] using the supplied A => Attempt[B].

Encodes all elements of the specified sequence and concatenates the results, or returns the first encountered error.

Converts this to a codec that fails decoding with an error.

Transforms using two functions, A => Attempt[B] and B => Attempt[A].

Converts this decoder to a Decoder[B] using the supplied A => Decoder[B].

Returns a new codec that encodes/decodes a value of type (A, B) where the codec of B is dependent on A.

Converts this decoder to a Decoder[B] using the supplied A => B.

Converts this encoder to an Encoder[B] using the supplied partial function from B to A. The encoding will fail for any B that f maps to None.

Lifts this codec in to a codec of a singleton tuple.

Converts this to a Codec[Unit] that encodes using the specified zero value and decodes a unit value when this codec decodes an A successfully.

Safely lifts this codec to a codec of a supertype.

When a subtype of B that is not a subtype of A is passed to encode, an encoding error is returned.

Creates a new codec that is functionally equivalent to this codec but pushes the specified context string in to any errors returned from encode or decode.

Creates a new codec that is functionally equivalent to this codec but returns the specified string from toString.

Transforms using the isomorphism described by two functions, A => B and B => A.

Assuming A is Unit, creates a Codec[B] that: encodes the unit followed by a B; decodes a unit followed by a B and discards the decoded unit.

Operator alias of dropLeft.