scodec.stream.encode

StreamEncoder

trait StreamEncoder[-A] extends AnyRef

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

Source
StreamEncoder.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
StreamCodec, StreamGenCodec
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StreamEncoder
  2. AnyRef
  3. Any
Implicitly
  1. by TransformSyntax
  2. by any2stringadd
  3. by any2stringfmt
  4. by any2ArrowAssoc
  5. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

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

    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: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

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

  5. def ++[A2 <: A](e: StreamEncoder[A2]): StreamEncoder[A2]

    Run this StreamEncoder, followed by e.

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

    Implicit information
    This member is added by an implicit conversion from StreamEncoder[A] to ArrowAssoc[StreamEncoder[A]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  7. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  8. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  9. def as[B](implicit as: Transformer[A, B]): StreamEncoder[B]

    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

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def chunk(bitsPerChunk: Long): StreamEncoder[A]

    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.

  12. def clone(): AnyRef

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

  13. final def contramap[A0](f0: (A0) ⇒ A): StreamEncoder[A0]

    Transform the input type of this StreamEncoder.

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

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

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

    Modify the Process1 backing this StreamEncoder.

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

    Encode the input stream of A values using this StreamEncoder.

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

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

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

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

  19. def ensuring(cond: (StreamEncoder[A]) ⇒ Boolean): StreamEncoder[A]

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

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

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

  21. def ensuring(cond: Boolean): StreamEncoder[A]

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

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

    Definition Classes
    AnyRef

  23. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  24. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): StreamEncoder[B]

    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

  25. def finalize(): Unit

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

  26. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from StreamEncoder[A] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  28. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  30. def many: StreamEncoder[A]

    Encode values as long as there are more inputs.

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

    Transform the output BitVector values produced by this encoder.

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

    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

    Definition Classes
    AnyRef

  34. final def notify(): Unit

    Definition Classes
    AnyRef

  35. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  36. def pipeBits(f: Process1[BitVector, BitVector]): StreamEncoder[A]

    Statefully transform the output BitVector values produced by this encoder.

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

    Definition Classes
    AnyRef

  38. def take(n: Int): StreamEncoder[A]

    Encode at most n values.

  39. def toString(): String

    Definition Classes
    AnyRef → Any

  40. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  43. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): StreamEncoder[B]

    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 widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): StreamEncoder[B]

    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 xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): StreamEncoder[B]

    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 →[B](y: B): (StreamEncoder[A], B)

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

Shadowed Implicit Value Members

  1. val self: StreamEncoder[A]

    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 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:
    (streamEncoder: TransformSyntax[StreamEncoder, A]).self
    Definition Classes
    TransformSyntax

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from StreamEncoder[A] to StringAdd performed by method any2stringadd in scala.Predef.
    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:
    (streamEncoder: StringAdd).self
    Definition Classes
    StringAdd

  3. val self: Any

    Implicit information
    This member is added by an implicit conversion from StreamEncoder[A] to StringFormat performed by method any2stringfmt in scala.Predef.
    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:
    (streamEncoder: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

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

    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

  2. def x: StreamEncoder[A]

    Implicit information
    This member is added by an implicit conversion from StreamEncoder[A] to ArrowAssoc[StreamEncoder[A]] performed by method any2ArrowAssoc in scala.Predef.
    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:
    (streamEncoder: ArrowAssoc[StreamEncoder[A]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: StreamEncoder[A]

    Implicit information
    This member is added by an implicit conversion from StreamEncoder[A] to Ensuring[StreamEncoder[A]] performed by method any2Ensuring in scala.Predef.
    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:
    (streamEncoder: Ensuring[StreamEncoder[A]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring 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 StringAdd

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

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

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

Ungrouped