scodec

Encoder

trait Encoder[-A] extends AnyRef

Supports encoding a value of type A to a BitVector.

Self Type
Encoder[A]
Source
Encoder.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Codec, DiscriminatorCodec, GenCodec, Tuple10Codec, Tuple11Codec, Tuple12Codec, Tuple3Codec, Tuple4Codec, Tuple5Codec, Tuple6Codec, Tuple7Codec, Tuple8Codec, Tuple9Codec, TupleCodec
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. Encoder
  2. AnyRef
  3. Any
Implicitly
  1. by EnrichedCoproductEncoder
  2. by TransformSyntax
  3. by any2stringadd
  4. by any2stringfmt
  5. by any2ArrowAssoc
  6. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def encode(value: A): Attempt[BitVector]

    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

  2. abstract def sizeBound: SizeBound

    Provides a bound on the size of successfully encoded values.

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Encoder[A], B)

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to ArrowAssoc[Encoder[A]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. def as[B](implicit as: Transformer[A, B]): Encoder[B]

    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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  9. def asEncoder: Encoder[A]

    Gets this as an Encoder.

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def compact: Encoder[A]

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

  13. def contramap[B](f: (B) ⇒ A): Encoder[B]

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

  14. def econtramap[B](f: (B) ⇒ Attempt[A]): Encoder[B]

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

  15. def encodeOnly: Codec[A]

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

  16. def ensuring(cond: (Encoder[A]) ⇒ Boolean, msg: ⇒ Any): Encoder[A]

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to Ensuring[Encoder[A]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  17. def ensuring(cond: (Encoder[A]) ⇒ Boolean): Encoder[A]

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to Ensuring[Encoder[A]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. def ensuring(cond: Boolean, msg: ⇒ Any): Encoder[A]

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to Ensuring[Encoder[A]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  19. def ensuring(cond: Boolean): Encoder[A]

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to Ensuring[Encoder[A]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  20. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  21. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  22. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): Encoder[B]

    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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  23. def exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): Encoder[B]

    Curried version of exmap.

    Curried version of exmap.

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  25. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  27. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  29. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): Encoder[B]

    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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  30. def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): Encoder[B]

    Curried version of narrow.

    Curried version of narrow.

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  31. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  32. final def notify(): Unit

    Definition Classes
    AnyRef

  33. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  34. def pcontramap[B](f: (B) ⇒ Option[A]): Encoder[B]

    Converts this encoder to an Encoder[B] using the supplied partial function from B to A.

    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.

  35. def selectEncoder[A](implicit inj: Inject[Coproduct, A]): Encoder[A]

    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 Encoder[A] 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

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

    Definition Classes
    AnyRef

  37. def toString(): String

    Definition Classes
    AnyRef → Any

  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): Encoder[B]

    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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  42. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Encoder[B]

    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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  43. def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): Encoder[B]

    Curried version of widenOpt.

    Curried version of widenOpt.

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  44. def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): Encoder[B]

    Curried version of widen.

    Curried version of widen.

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  45. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): Encoder[B]

    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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  46. def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): Encoder[B]

    Curried version of xmap.

    Curried version of xmap.

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax

  47. def →[B](y: B): (Encoder[A], B)

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

Shadowed Implicit Value Members

  1. val self: Encoder[Coproduct]

    Implicit information
    This member is added by an implicit conversion from Encoder[A] 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:
    (encoder: EnrichedCoproductEncoder[Coproduct]).self
    Definition Classes
    EnrichedCoproductEncoder

  2. val self: Encoder[A]

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    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:
    (encoder: TransformSyntax[Encoder, A]).self
    Definition Classes
    TransformSyntax

  3. val self: Any

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to StringAdd performed by method any2stringadd in scala.Predef.
    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:
    (encoder: StringAdd).self
    Definition Classes
    StringAdd

  4. val self: Any

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to StringFormat performed by method any2stringfmt in scala.Predef.
    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:
    (encoder: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

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

    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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.0) Use widenOpt instead

  2. def x: Encoder[A]

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to ArrowAssoc[Encoder[A]] performed by method any2ArrowAssoc in scala.Predef.
    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:
    (encoder: ArrowAssoc[Encoder[A]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: Encoder[A]

    Implicit information
    This member is added by an implicit conversion from Encoder[A] to Ensuring[Encoder[A]] performed by method any2Ensuring in scala.Predef.
    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:
    (encoder: Ensuring[Encoder[A]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion EnrichedCoproductEncoder from Encoder[A] to EnrichedCoproductEncoder[Coproduct]

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

Inherited by implicit conversion any2stringadd from Encoder[A] to StringAdd

Inherited by implicit conversion any2stringfmt from Encoder[A] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Encoder[A] to ArrowAssoc[Encoder[A]]

Inherited by implicit conversion any2Ensuring from Encoder[A] to Ensuring[Encoder[A]]

Primary Members

Basic Combinators

Coproduct Support

Ungrouped