Class/Object

scodec.stream

StreamEncoder

Related Docs: object StreamEncoder | package stream

Permalink

final class StreamEncoder[A] extends AnyRef

A streaming encoding process, represented as a Stream[Pure, A] => Pull[Pure, BitVector, Option[(Stream[Pure, A], StreamEncoder[A])]].

Self Type
StreamEncoder[A]
Source
StreamEncoder.scala
Linear Supertypes
AnyRef, Any
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

Instance Constructors

  1. new StreamEncoder(step: Step[A])

    Permalink

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 ++(that: ⇒ StreamEncoder[A]): StreamEncoder[A]

    Permalink

    Creates a stream encoder that first encodes with this encoder and then when complete, encodes the remainder with the supplied encoder.

  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 clone(): AnyRef

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

  10. def encode[F[_]](in: Stream[F, A])(implicit arg0: RaiseThrowable[F]): Stream[F, BitVector]

    Permalink

    Encodes the supplied stream of A values in to a stream of BitVector.

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

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

  20. def finalize(): Unit

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

  21. 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()

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

    Permalink
    Definition Classes
    AnyRef → Any

  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

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

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

    Permalink
    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. def repeat: StreamEncoder[A]

    Permalink

    Encodes values as long as there are more inputs.

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

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

    Permalink
    Definition Classes
    AnyRef

  33. def toPipe[F[_]](implicit arg0: RaiseThrowable[F]): Pipe[F, A, BitVector]

    Permalink

    Converts this encoder to a Pipe[F, A, BitVector].

  34. def toPipeByte[F[_]](implicit arg0: RaiseThrowable[F]): Pipe[F, A, Byte]

    Permalink

    Converts this encoder to a Pipe[F, A, Byte].

  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]): 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

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

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

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

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

  44. def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): StreamEncoder[B]

    Permalink

    Transform the input type of this StreamEncoder.

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

Shadowed Implicit Value Members

  1. 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.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (streamEncoder: TransformSyntax[StreamEncoder, A]).xmapc(f)(g)
    Definition Classes
    TransformSyntax

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