Trait/Object

scodec

Encoder

Related Docs: object Encoder | package scodec

Permalink

trait Encoder[-A] extends AnyRef

Supports encoding a value of type A to a BitVector.

Self Type
Encoder[A]
Source
Encoder.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
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 StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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

  2. abstract def sizeBound: SizeBound

    Permalink

    Provides a bound on the size of successfully encoded values.

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 Encoder[A] to any2stringadd[Encoder[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Encoder[A], B)

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

    Permalink

    Gets this as an Encoder.

  8. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def compact: Encoder[A]

    Permalink

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

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

    Permalink

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

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

    Permalink

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

  13. def encodeOnly: Codec[A]

    Permalink

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  21. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Encoder[A] to StringFormat[Encoder[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  27. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  28. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  29. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  32. def pcontramap[B](f: (B) ⇒ Option[A]): Encoder[B]

    Permalink

    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.

  33. 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 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
  34. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  40. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  41. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  42. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  43. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  44. 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 Encoder[A] to TransformSyntax[Encoder, A] performed by method TransformSyntax in scodec.
    Definition Classes
    TransformSyntax
  45. def [B](y: B): (Encoder[A], B)

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

Shadowed Implicit Value Members

  1. val self: Encoder[Coproduct]

    Permalink
    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]

    Permalink

    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

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 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

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

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

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

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

Primary Members

Basic Combinators

Coproduct Support

Ungrouped