Trait/Object

scodec

GenCodec

Related Docs: object GenCodec | package scodec

Permalink

trait GenCodec[-A, +B] extends Encoder[A] with Decoder[B]

Generalized codec that allows the type to encode to vary from the type to decode.

Self Type
GenCodec[A, B]
Source
GenCodec.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. GenCodec
  2. Decoder
  3. Encoder
  4. AnyRef
  5. Any
Implicitly
  1. by EnrichedCoproductDecoder
  2. by EnrichedCoproductEncoder
  3. by TransformSyntax
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decode(bits: BitVector): Attempt[DecodeResult[B]]

    Permalink

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

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

    bits

    bits to decode

    returns

    error if value could not be decoded or the remaining bits and the decoded value

    Definition Classes
    Decoder
  2. abstract def encode(value: A): Attempt[BitVector]

    Permalink

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

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

    value

    value to encode

    returns

    error or binary encoding of the value

    Definition Classes
    Encoder
  3. abstract def sizeBound: SizeBound

    Permalink

    Provides a bound on the size of successfully encoded values.

    Provides a bound on the size of successfully encoded values.

    Definition Classes
    Encoder

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to any2stringadd[GenCodec[A, B]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GenCodec[A, B], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to ArrowAssoc[GenCodec[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def as[B](implicit as: Transformer[A, B]): Encoder[B]

    Permalink

    Transforms using implicitly available evidence that such a transformation is possible.

    Transforms using implicitly available evidence that such a transformation is possible.

    Typical transformations include converting:

    • an F[L] for some L <: HList to/from an F[CC] for some case class CC, where the types in the case class are aligned with the types in L
    • an F[C] for some C <: Coproduct to/from an F[SC] for some sealed class SC, where the component types in the coproduct are the leaf subtypes of the sealed class.
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  7. def asDecoder: Decoder[B]

    Permalink

    Gets this as a Decoder.

    Gets this as a Decoder.

    Definition Classes
    Decoder
  8. def asEncoder: Encoder[A]

    Permalink

    Gets this as an Encoder.

    Gets this as an Encoder.

    Definition Classes
    Encoder
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def compact: GenCodec[A, B]

    Permalink

    Converts this codec to a new codec that compacts the encoded bit vector before returning it.

    Converts this codec to a new codec that compacts the encoded bit vector before returning it.

    Definition Classes
    GenCodecEncoder
  12. def complete: GenCodec[A, B]

    Permalink

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

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

    Definition Classes
    GenCodecDecoder
  13. def contramap[C](f: (C) ⇒ A): GenCodec[C, B]

    Permalink

    Converts this GenCodec to a GenCodec[C, B] using the supplied C => A.

    Converts this GenCodec to a GenCodec[C, B] using the supplied C => A.

    Definition Classes
    GenCodecEncoder
  14. def decodeOnly[AA >: B]: Codec[AA]

    Permalink

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

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

    Definition Classes
    Decoder
  15. final def decodeValue(bits: BitVector): Attempt[B]

    Permalink

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

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

    bits

    bits to decode

    returns

    error if value could not be decoded or the decoded value

    Definition Classes
    Decoder
  16. def econtramap[C](f: (C) ⇒ Attempt[A]): GenCodec[C, B]

    Permalink

    Converts this GenCodec to a GenCodec[C, B] using the supplied C => Attempt[A].

    Converts this GenCodec to a GenCodec[C, B] using the supplied C => Attempt[A].

    Definition Classes
    GenCodecEncoder
  17. def emap[C](f: (B) ⇒ Attempt[C]): GenCodec[A, C]

    Permalink

    Converts this GenCodec to a GenCodec[A, C] using the supplied B => Attempt[C].

    Converts this GenCodec to a GenCodec[A, C] using the supplied B => Attempt[C].

    Definition Classes
    GenCodecDecoder
  18. def encodeOnly: Codec[A]

    Permalink

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

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

    Definition Classes
    Encoder
  19. def ensuring(cond: (GenCodec[A, B]) ⇒ Boolean, msg: ⇒ Any): GenCodec[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to Ensuring[GenCodec[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: (GenCodec[A, B]) ⇒ Boolean): GenCodec[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to Ensuring[GenCodec[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean, msg: ⇒ Any): GenCodec[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to Ensuring[GenCodec[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean): GenCodec[A, B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to Ensuring[GenCodec[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  25. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): Encoder[B]

    Permalink

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

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

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  26. def exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): Encoder[B]

    Permalink

    Curried version of exmap.

    Curried version of exmap.

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  27. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def flatMap[B](f: (B) ⇒ Decoder[B]): Decoder[B]

    Permalink

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

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

    Definition Classes
    Decoder
  29. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to StringFormat[GenCodec[A, B]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  30. final def fuse[AA <: A, BB >: B](implicit ev: =:=[BB, AA]): Codec[BB]

    Permalink

    Converts this generalized codec in to a non-generalized codec assuming A and B are the same type.

  31. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  34. def map[C](f: (B) ⇒ C): GenCodec[A, C]

    Permalink

    Converts this GenCodec to a GenCodec[A, C] using the supplied B => C.

    Converts this GenCodec to a GenCodec[A, C] using the supplied B => C.

    Definition Classes
    GenCodecDecoder
  35. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): Encoder[B]

    Permalink

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

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

    The supplied functions form an injection from B to A. Hence, this method converts from a larger to a smaller type. Hence, the name narrow.

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  36. def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): Encoder[B]

    Permalink

    Curried version of narrow.

    Curried version of narrow.

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  37. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  40. def pcontramap[C](f: (C) ⇒ Option[A]): GenCodec[C, B]

    Permalink

    Converts this GenCodec to a GenCodec[C, B] using the supplied partial function from C to A.

    Converts this GenCodec to a GenCodec[C, B] using the supplied partial function from C to A. The encoding will fail for any C that f maps to None.

    Definition Classes
    GenCodecEncoder
  41. def selectDecoder[A](implicit sel: Selector[B, A]): Decoder[Option[A]]

    Permalink

    When called on a Decoder[C] where C is a coproduct containing type A, converts to a Decoder[Option[A]].

    When called on a Decoder[C] where C is a coproduct containing type A, converts to a Decoder[Option[A]].

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to EnrichedCoproductDecoder[B] performed by method EnrichedCoproductDecoder in scodec. This conversion will take place only if B is a subclass of Coproduct (B <: Coproduct).
    Definition Classes
    EnrichedCoproductDecoder
  42. def selectEncoder[A](implicit inj: Inject[Coproduct, A]): Encoder[A]

    Permalink

    When called on a Encoder[C] where C is a coproduct containing type A, converts to an Encoder[A].

    When called on a Encoder[C] where C is a coproduct containing type A, converts to an Encoder[A].

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to EnrichedCoproductEncoder[Coproduct] performed by method EnrichedCoproductEncoder in scodec. This conversion will take place only if A is a superclass of Coproduct (A >: Coproduct).
    Definition Classes
    EnrichedCoproductEncoder
  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  44. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): Encoder[B]

    Permalink

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

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

    The supplied functions form an injection from A to B. Hence, this method converts from a smaller to a larger type. Hence, the name widen.

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  49. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Encoder[B]

    Permalink

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

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

    Particularly useful when combined with case class apply/unapply. E.g., widenOpt(fa, Foo.apply, Foo.unapply).

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  50. def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): Encoder[B]

    Permalink

    Curried version of widenOpt.

    Curried version of widenOpt.

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  51. def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): Encoder[B]

    Permalink

    Curried version of widen.

    Curried version of widen.

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  52. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): Encoder[B]

    Permalink

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

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

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  53. def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): Encoder[B]

    Permalink

    Curried version of xmap.

    Curried version of xmap.

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
  54. def [B](y: B): (GenCodec[A, B], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to ArrowAssoc[GenCodec[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Decoder[B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to EnrichedCoproductDecoder[B] performed by method EnrichedCoproductDecoder in scodec. This conversion will take place only if B is a subclass of Coproduct (B <: Coproduct).
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (genCodec: EnrichedCoproductDecoder[B]).self
    Definition Classes
    EnrichedCoproductDecoder
  2. val self: Encoder[Coproduct]

    Permalink
    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to EnrichedCoproductEncoder[Coproduct] performed by method EnrichedCoproductEncoder in scodec. This conversion will take place only if A is a superclass of Coproduct (A >: Coproduct).
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (genCodec: EnrichedCoproductEncoder[Coproduct]).self
    Definition Classes
    EnrichedCoproductEncoder
  3. val self: Encoder[A]

    Permalink

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (genCodec: TransformSyntax[Encoder, A]).self
    Definition Classes
    TransformSyntax

Deprecated Value Members

  1. def pxmap[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Encoder[B]

    Permalink

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

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

    Particularly useful when combined with case class apply/unapply. E.g., pxmap(fa, Foo.apply, Foo.unapply).

    Implicit information
    This member is added by an implicit conversion from GenCodec[A, B] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Encoder] is in scope.
    Definition Classes
    TransformSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.0) Use widenOpt instead

Inherited from Decoder[B]

Inherited from Encoder[A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion EnrichedCoproductDecoder from GenCodec[A, B] to EnrichedCoproductDecoder[B]

Inherited by implicit conversion EnrichedCoproductEncoder from GenCodec[A, B] to EnrichedCoproductEncoder[Coproduct]

Inherited by implicit conversion TransformSyntax from GenCodec[A, B] to TransformSyntax[Encoder, A]

Inherited by implicit conversion any2stringadd from GenCodec[A, B] to any2stringadd[GenCodec[A, B]]

Inherited by implicit conversion StringFormat from GenCodec[A, B] to StringFormat[GenCodec[A, B]]

Inherited by implicit conversion Ensuring from GenCodec[A, B] to Ensuring[GenCodec[A, B]]

Inherited by implicit conversion ArrowAssoc from GenCodec[A, B] to ArrowAssoc[GenCodec[A, B]]

Primary Members

Basic Combinators

Coproduct Support

Ungrouped