Trait/Object

scodec.stream.encode

StreamEncoder

Related Docs: object StreamEncoder | package encode

Permalink

trait StreamEncoder[-A] extends AnyRef

A streaming encoding process, represented as a Process1[A,BitVector].

Source
StreamEncoder.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StreamEncoder
  2. AnyRef
  3. Any
Implicitly
  1. by TransformSyntax
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def encoder: Process1[A, BitVector]

    Permalink

    The Process1 backing this StreamEncoder[A].

    The Process1 backing this StreamEncoder[A]. All functions on StreamEncoder are defined in terms of this Process1.

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 StreamEncoder[A] to any2stringadd[StreamEncoder[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ++[A2 <: A](e: StreamEncoder[A2]): StreamEncoder[A2]

    Permalink

    Run this StreamEncoder, followed by e.

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from StreamEncoder[A] to TransformSyntax[StreamEncoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[StreamEncoder] is in scope.
    Definition Classes
    TransformSyntax
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def chunk(bitsPerChunk: Long): StreamEncoder[A]

    Permalink

    Convert this StreamEncoder to output bits in the given chunk size.

    Convert this StreamEncoder to output bits in the given chunk size. Only the last chunk may have fewer than bitsPerChunk bits.

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def contramap[A0](f0: (A0) ⇒ A): StreamEncoder[A0]

    Permalink

    Transform the input type of this StreamEncoder.

  12. final def contrapipe[A0](p: Process1[A0, A]): StreamEncoder[A0]

    Permalink

    Transform the input type of this StreamEncoder using the given transducer.

  13. final def edit[A2](f: (Process1[A, BitVector]) ⇒ Process1[A2, BitVector]): StreamEncoder[A2]

    Permalink

    Modify the Process1 backing this StreamEncoder.

  14. final def encode[F[_]](in: Process[F, A]): Process[F, BitVector]

    Permalink

    Encode the input stream of A values using this StreamEncoder.

  15. def encodeAllValid(in: Seq[A]): BitVector

    Permalink

    Encode the given sequence of A values to a BitVector, raising an exception in the event of an encoding error.

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  29. def many: StreamEncoder[A]

    Permalink

    Encode values as long as there are more inputs.

  30. def mapBits(f: (BitVector) ⇒ BitVector): StreamEncoder[A]

    Permalink

    Transform the output BitVector values produced by this encoder.

  31. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): StreamEncoder[B]

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  36. def pipeBits(f: Process1[BitVector, BitVector]): StreamEncoder[A]

    Permalink

    Statefully transform the output BitVector values produced by this encoder.

  37. val self: StreamEncoder[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from StreamEncoder[A] to TransformSyntax[StreamEncoder, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[StreamEncoder] is in scope.
    Definition Classes
    TransformSyntax
  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  39. def take(n: Int): StreamEncoder[A]

    Permalink

    Encode at most n values.

  40. def toString(): String

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

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

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

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

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

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

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

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

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

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

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

Deprecated Value Members

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

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

    (Since version 1.7.0) Use widenOpt instead

Inherited from AnyRef

Inherited from Any

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

Inherited by implicit conversion any2stringadd from StreamEncoder[A] to any2stringadd[StreamEncoder[A]]

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

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

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

Ungrouped