Encoder

Abstract Value Members

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
abstract def sizeBound: SizeBound

Provides a bound on the size of successfully encoded values.

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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
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 ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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
def asEncoder: Encoder[A]

Gets this as an Encoder.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Converts this encoder to a new encoder that compacts the generated bit vector before returning it
def contramap[B](f: (B) ⇒ A): Encoder[B]

Converts this encoder to an Encoder[B] using the supplied B => A.
def econtramap[B](f: (B) ⇒ Attempt[A]): Encoder[B]

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

Converts this to a codec that fails decoding with an error.
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
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
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
def finalize(): Unit

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

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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
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
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
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
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
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
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
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
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
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 ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implicit Value Members

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

Deprecated Value Members

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

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

Related Docs: object Encoder | package scodec

trait Encoder[-A] extends AnyRef

Abstract Value Members

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

abstract def sizeBound: SizeBound

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

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

final def ==(arg0: Any): Boolean

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

def asEncoder: Encoder[A]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def compact: Encoder[A]

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

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

def encodeOnly: Codec[A]

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

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

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

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

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

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

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

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

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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

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

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

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

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

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

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

Shadowed Implicit Value Members

val self: Encoder[Coproduct]

val self: Encoder[A]

Deprecated Value Members

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

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