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
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 any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  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): \/[String, 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

Concrete Value Members

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

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

    Definition Classes
    AnyRef → Any
  3. 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
  4. 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()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

  10. final def encodeValid(value: A): BitVector

    Encodes the specified value in to a bit vector, throwing an IllegalArgumentException if encoding fails.

    Encodes the specified value in to a bit vector, throwing an IllegalArgumentException if encoding fails.

    value

    value to encode

    Exceptions thrown
    IllegalArgumentException

    upon encoding failure

  11. 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
  12. 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
  13. 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
  14. 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
  15. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. 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()
  19. final def getClass(): Class[_]

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

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

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

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

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

    Definition Classes
    AnyRef
  25. 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.

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

    Definition Classes
    AnyRef
  27. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. 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

Inherited from AnyRef

Inherited from Any

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

Ungrouped