scodec

GenCodec

object GenCodec extends EncoderFunctions with DecoderFunctions

Companion for GenCodec.

Source
GenCodec.scala
Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. GenCodec
  2. DecoderFunctions
  3. EncoderFunctions
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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. def apply[A, B](encoder: Encoder[A], decoder: Decoder[B]): GenCodec[A, B]

    Creates a generalized codec from an encoder and a decoder.

  5. def apply[A, B](implicit gc: GenCodec[A, B]): GenCodec[A, B]

    Provides syntax for summoning a GenCodec[A, B] from implicit scope.

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. final def choiceDecoder[A](decoders: Decoder[A]*): Decoder[A]

    Creates a decoder that decodes with each of the specified decoders, returning the first successful result.

    Creates a decoder that decodes with each of the specified decoders, returning the first successful result.

    Definition Classes
    DecoderFunctions
  8. final def choiceEncoder[A](encoders: Encoder[A]*): Encoder[A]

    Creates an encoder that encodes with each of the specified encoders, returning the first successful result.

    Creates an encoder that encodes with each of the specified encoders, returning the first successful result.

    Definition Classes
    EncoderFunctions
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def decode[A](bits: BitVector)(implicit arg0: Decoder[A]): \/[Err, (BitVector, A)]

    Decodes the specified bit vector in to a value of type A using an implicitly available codec.

    Decodes the specified bit vector in to a value of type A using an implicitly available codec.

    Definition Classes
    DecoderFunctions
  11. final def decodeAll[A, B](buffer: BitVector)(f: (A) ⇒ B)(implicit arg0: Decoder[A], arg1: Monoid[B]): (Option[Err], B)

    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 Monoid[B].

    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 Monoid[B]. Terminates when no more bits are available in the vector. Exits upon first decoding error.

    returns

    tuple consisting of the terminating error if any and the accumulated value

    Definition Classes
    DecoderFunctions
  12. final def decodeBoth[A, B](decA: Decoder[A], decB: Decoder[B])(buffer: BitVector): \/[Err, (BitVector, (A, B))]

    Decodes a tuple (A, B) by first decoding A and then using the remaining bits to decode B.

    Decodes a tuple (A, B) by first decoding A and then using the remaining bits to decode B.

    Definition Classes
    DecoderFunctions
  13. final def decodeBothCombine[A, B, C](decA: Decoder[A], decB: Decoder[B])(buffer: BitVector)(f: (A, B) ⇒ C): \/[Err, (BitVector, C)]

    Decodes a C by first decoding A and then using the remaining bits to decode B, then applying the decoded values to the specified function to generate a C.

    Decodes a C by first decoding A and then using the remaining bits to decode B, then applying the decoded values to the specified function to generate a C.

    Definition Classes
    DecoderFunctions
  14. final def decodeCollect[F[_], A](dec: Decoder[A], limit: Option[Int])(buffer: BitVector)(implicit cbf: CanBuildFrom[F[A], A, F[A]]): \/[Err, (BitVector, F[A])]

    Repeatedly decodes values of type A from the specified vector and returns a collection of the specified type.

    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.

    Definition Classes
    DecoderFunctions
  15. final def decodeValidValue[A](bits: BitVector)(implicit arg0: Decoder[A]): A

    Decodes the specified bit vector in to a value of type A using an implicitly available codec and discards the remaining bits or throws an IllegalArgumentException if decoding fails.

    Decodes the specified bit vector in to a value of type A using an implicitly available codec and discards the remaining bits or throws an IllegalArgumentException if decoding fails.

    Definition Classes
    DecoderFunctions
  16. final def decodeValue[A](bits: BitVector)(implicit arg0: Decoder[A]): \/[Err, A]

    Decodes the specified bit vector in to a value of type A using an implicitly available codec and discards the remaining bits.

    Decodes the specified bit vector in to a value of type A using an implicitly available codec and discards the remaining bits.

    Definition Classes
    DecoderFunctions
  17. final def encode[A](a: A)(implicit arg0: Encoder[A]): \/[Err, BitVector]

    Encodes the specified value to a bit vector using an implicitly available encoder.

    Encodes the specified value to a bit vector using an implicitly available encoder.

    Definition Classes
    EncoderFunctions
  18. final def encodeBoth[A, B](encA: Encoder[A], encB: Encoder[B])(a: A, b: B): \/[Err, BitVector]

    Encodes the specified values, one after the other, to a bit vector using the specified encoders.

    Encodes the specified values, one after the other, to a bit vector using the specified encoders.

    Definition Classes
    EncoderFunctions
  19. final def encodeSeq[A](enc: Encoder[A])(seq: Seq[A]): \/[Err, BitVector]

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

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

    Definition Classes
    EncoderFunctions
  20. final def encodeValid[A](a: A)(implicit arg0: Encoder[A]): BitVector

    Encodes the specified value to a bit vector using an implicitly available encoder or throws an IllegalArgumentException if encoding fails.

    Encodes the specified value to a bit vector using an implicitly available encoder or throws an IllegalArgumentException if encoding fails.

    Definition Classes
    EncoderFunctions
  21. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  30. implicit val profunctorInstance: Profunctor[GenCodec]

    Profunctor instance.

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

    Definition Classes
    AnyRef
  32. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from DecoderFunctions

Inherited from EncoderFunctions

Inherited from AnyRef

Inherited from Any

Constructors

Conveniences

Typeclass Instances

Ungrouped