Packages

trait StreamGenCodec[I, +O] extends StreamEncoder[I] with StreamDecoder[O]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamGenCodec
  2. StreamDecoder
  3. StreamEncoder
  4. AnyRef
  5. 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 decoder: Stream[Cursor, O]

    The Stream backing this StreamDecoder.

    The Stream backing this StreamDecoder. All functions on StreamDecoder are defined in terms of this Stream.

    Definition Classes
    StreamDecoder
  2. abstract def encoder: Step[I]
    Definition Classes
    StreamEncoder

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
    This member is added by an implicit conversion from StreamGenCodec[I, O] to any2stringadd[StreamGenCodec[I, O]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. final def ++[A2 >: O](d: ⇒ decode.StreamDecoder[A2]): decode.StreamDecoder[A2]

    Run this StreamDecoder, then d, then concatenate the two streams.

    Run this StreamDecoder, then d, then concatenate the two streams.

    Definition Classes
    StreamDecoder
  5. def ++(e: ⇒ encode.StreamEncoder[I]): encode.StreamEncoder[I]

    Run this StreamEncoder, followed by e.

    Run this StreamEncoder, followed by e.

    Definition Classes
    StreamEncoder
  6. def ->[B](y: B): (StreamGenCodec[I, O], B)
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to ArrowAssoc[StreamGenCodec[I, O]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def as[B](implicit as: Transformer[I, B]): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def collect[B](pf: PartialFunction[O, B]): decode.StreamDecoder[B]

    Transform the output of this StreamDecoder using the partial function pf.

    Transform the output of this StreamDecoder using the partial function pf.

    Definition Classes
    StreamDecoder
  12. final def decode(bits: ⇒ BitVector): Stream[Task, O]

    Decoding a stream of A values from the given BitVector.

    Decoding a stream of A values from the given BitVector. This function does not retain a reference to bits, allowing it to be be garbage collected as the returned stream is traversed.

    Definition Classes
    StreamDecoder
  13. def decodeAllValid(bits: ⇒ BitVector): Vector[O]

    Decode the given BitVector, returning a strict Vector of the results, and throwing an exception in the event of a decoding error.

    Decode the given BitVector, returning a strict Vector of the results, and throwing an exception in the event of a decoding error.

    Definition Classes
    StreamDecoder
  14. final def decodeAsyncResource[R](acquire: Task[R])(read: (R) ⇒ BitVector, release: (R) ⇒ Task[Unit]): Stream[Task, O]

    Resource-safe version of decode.

    Resource-safe version of decode. Acquires a resource, decodes a stream of values, and releases the resource when the returned Stream[Task,A] is finished being consumed. The acquire and release actions may be asynchronous.

    Definition Classes
    StreamDecoder
  15. final def decodeChannel(in: ⇒ ReadableByteChannel, chunkSizeInBytes: Int = 1024 * 1000 * 16, direct: Boolean = false): Stream[Task, O]

    Resource-safe version of decode for a ReadableByteChannel resource.

    Resource-safe version of decode for a ReadableByteChannel resource. This is just a convenience function which calls decodeResource, using scodec.bits.BitVector.fromChannel as the read function, and which closes in after the returned Stream[Task,A] is consumed.

    Definition Classes
    StreamDecoder
  16. final def decodeInputStream(in: ⇒ InputStream, chunkSizeInBytes: Int = 1024 * 1000 * 16): Stream[Task, O]

    Resource-safe version of decode for an InputStream resource.

    Resource-safe version of decode for an InputStream resource. This is just a convenience function which calls decodeResource, using scodec.bits.BitVector.fromInputStream as the read function, and which closes in after the returned Stream[Task,A] is consumed.

    Definition Classes
    StreamDecoder
  17. final def decodeMmap(in: ⇒ FileChannel, chunkSizeInBytes: Int = 1024 * 1000 * 16): Stream[Task, O]

    Resource-safe version of decode for a ReadableByteChannel resource.

    Resource-safe version of decode for a ReadableByteChannel resource. This is just a convenience function which calls decodeResource, using scodec.bits.BitVector.fromChannel as the read function, and which closes in after the returned Stream[Task,A] is consumed.

    Definition Classes
    StreamDecoder
  18. final def decodeResource[R](acquire: ⇒ R)(read: (R) ⇒ BitVector, release: (R) ⇒ Unit): Stream[Task, O]

    Resource-safe version of decode.

    Resource-safe version of decode. Acquires a resource, decodes a stream of values, and releases the resource when the returned Stream[Task,A] is finished being consumed. If the acquire and release actions are asynchronous, use decodeAsyncResource.

    Definition Classes
    StreamDecoder
  19. def drop(n: Int): decode.StreamDecoder[O]

    Ignore the first n decoded values.

    Ignore the first n decoded values.

    Definition Classes
    StreamDecoder
  20. def dropWhile(f: (O) ⇒ Boolean): decode.StreamDecoder[O]

    Ignore decoded values as long as the predicate tests true.

    Ignore decoded values as long as the predicate tests true.

    Definition Classes
    StreamDecoder
  21. final def edit[B](f: (Stream[Cursor, O]) ⇒ Stream[Cursor, B]): decode.StreamDecoder[B]

    Modify the Stream[Cursor,A] backing this StreamDecoder.

    Modify the Stream[Cursor,A] backing this StreamDecoder.

    Definition Classes
    StreamDecoder
  22. def edit[B](f: (Step[I]) ⇒ Step[B]): encode.StreamEncoder[B]

    Modify the Pull backing this StreamEncoder.

    Modify the Pull backing this StreamEncoder.

    Definition Classes
    StreamEncoder
  23. def editDecoder[O2](f: (StreamDecoder[O]) ⇒ StreamDecoder[O2]): StreamGenCodec[I, O2]
  24. def editEncoder[I2](f: (StreamEncoder[I]) ⇒ StreamEncoder[I2]): StreamGenCodec[I2, O]
  25. final def encode[F[_]](in: Stream[F, I]): Stream[F, BitVector]

    Encode the input stream of A values using this StreamEncoder.

    Encode the input stream of A values using this StreamEncoder.

    Definition Classes
    StreamEncoder
  26. def encodeAllValid(in: Seq[I]): BitVector

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

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

    Definition Classes
    StreamEncoder
  27. def ensuring(cond: (StreamGenCodec[I, O]) ⇒ Boolean, msg: ⇒ Any): StreamGenCodec[I, O]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to Ensuring[StreamGenCodec[I, O]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: (StreamGenCodec[I, O]) ⇒ Boolean): StreamGenCodec[I, O]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to Ensuring[StreamGenCodec[I, O]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: Boolean, msg: ⇒ Any): StreamGenCodec[I, O]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to Ensuring[StreamGenCodec[I, O]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: Boolean): StreamGenCodec[I, O]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to Ensuring[StreamGenCodec[I, O]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  33. def exmap[B](f: (I) ⇒ Attempt[B], g: (B) ⇒ Attempt[I]): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  34. def exmapc[B](f: (I) ⇒ Attempt[B])(g: (B) ⇒ Attempt[I]): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  35. def filter(f: (O) ⇒ Boolean): decode.StreamDecoder[O]

    Skip any decoded values for which the predicate tests false.

    Skip any decoded values for which the predicate tests false.

    Definition Classes
    StreamDecoder
  36. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def firstAfter(f: (O) ⇒ Boolean): decode.StreamDecoder[O]

    Equivalent to dropWhile(f).take(1) - returns a stream of (at most) one element, consisting of the first output for which f tests false.

    Equivalent to dropWhile(f).take(1) - returns a stream of (at most) one element, consisting of the first output for which f tests false.

    Definition Classes
    StreamDecoder
  38. final def flatMap[B](f: (O) ⇒ decode.StreamDecoder[B]): decode.StreamDecoder[B]

    Monadic bind for this StreamDecoder.

    Monadic bind for this StreamDecoder. Runs a stream decoder for each A produced by this StreamDecoder, then concatenates all the resulting streams of results. This is the same 'idea' as List.flatMap.

    Definition Classes
    StreamDecoder
  39. final def flatMapS[B](f: (O) ⇒ Stream[Cursor, B]): decode.StreamDecoder[B]

    Like flatMap, but takes a function that produces a Stream[Cursor,B].

    Like flatMap, but takes a function that produces a Stream[Cursor,B].

    Definition Classes
    StreamDecoder
  40. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to StringFormat[StreamGenCodec[I, O]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  41. def fuse[OO >: O](implicit ev: =:=[OO, I]): StreamCodec[OO]

    Promote to a StreamCodec[O] given evidence that I and O are equal.

  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  44. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  45. def isolate(numberOfBits: Long): decode.StreamDecoder[O]

    Alias for decode.isolate(numberOfBits)(this).

    Alias for decode.isolate(numberOfBits)(this).

    Definition Classes
    StreamDecoder
  46. def isolateBytes(numberOfBytes: Long): decode.StreamDecoder[O]

    Alias for decode.isolateBytes(numberOfBytes)(this).

    Alias for decode.isolateBytes(numberOfBytes)(this).

    Definition Classes
    StreamDecoder
  47. def many: StreamGenCodec[I, O]

    Run this StreamDecoder zero or more times until the input is exhausted.

    Run this StreamDecoder zero or more times until the input is exhausted.

    Definition Classes
    StreamGenCodec → StreamDecoder → StreamEncoder
  48. def many1: decode.StreamDecoder[O]

    Run this StreamDecoder one or more times until the input is exhausted.

    Run this StreamDecoder one or more times until the input is exhausted.

    Definition Classes
    StreamDecoder
  49. final def map[B](f: (O) ⇒ B): decode.StreamDecoder[B]

    Transform the output of this StreamDecoder using the function f.

    Transform the output of this StreamDecoder using the function f.

    Definition Classes
    StreamDecoder
  50. final def mapEither[B](f: (O) ⇒ Either[Err, B]): decode.StreamDecoder[B]

    Transform the output of this StreamDecoder, converting left values to decoding failures.

    Transform the output of this StreamDecoder, converting left values to decoding failures.

    Definition Classes
    StreamDecoder
  51. def narrow[B](f: (I) ⇒ Attempt[B], g: (B) ⇒ I): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  52. def narrowc[B](f: (I) ⇒ Attempt[B])(g: (B) ⇒ I): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. def nonEmpty(errIfEmpty: Err): decode.StreamDecoder[O]

    Raises a decoding error if the given decoder emits no results, otherwise runs s as normal.

    Raises a decoding error if the given decoder emits no results, otherwise runs s as normal.

    Definition Classes
    StreamDecoder
  55. final def notify(): Unit
    Definition Classes
    AnyRef
  56. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  57. final def onComplete[A2 >: O](d: ⇒ decode.StreamDecoder[A2]): decode.StreamDecoder[A2]

    Run this StreamDecoder, then d, then concatenate the two streams, even if this halts with an error.

    Run this StreamDecoder, then d, then concatenate the two streams, even if this halts with an error. The error will be reraised when d completes. See fs2.Stream.onComplete.

    Definition Classes
    StreamDecoder
  58. final def or[A2 >: O](d: decode.StreamDecoder[A2]): decode.StreamDecoder[A2]

    Alias for scodec.stream.decode.or(this,d).

    Alias for scodec.stream.decode.or(this,d). Runs this, then runs d if this emits no elements. Example: tryOnce(codecs.int32).or(once(codecs.uint32)). This function does no backtracking of its own; any desired backtracking should be handled by this.

    Definition Classes
    StreamDecoder
  59. def or(other: encode.StreamEncoder[I]): encode.StreamEncoder[I]
    Definition Classes
    StreamEncoder
  60. def peek: decode.StreamDecoder[O]

    Alias for scodec.stream.decode.peek(this).

    Alias for scodec.stream.decode.peek(this).

    Definition Classes
    StreamDecoder
  61. val self: StreamEncoder[I]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  62. def sepBy[B](implicit B: Lazy[Decoder[B]]): decode.StreamDecoder[O]

    Alternate between decoding A values using this StreamDecoder, and decoding B values which are ignored.

    Alternate between decoding A values using this StreamDecoder, and decoding B values which are ignored.

    Definition Classes
    StreamDecoder
  63. final def strict: Decoder[Vector[O]]

    Create a strict (i.e., non-stream) decoder.

    Create a strict (i.e., non-stream) decoder.

    Definition Classes
    StreamDecoder
  64. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  65. def take(n: Long): StreamGenCodec[I, O]

    Decode at most n values using this StreamDecoder.

    Decode at most n values using this StreamDecoder.

    Definition Classes
    StreamGenCodec → StreamDecoder → StreamEncoder
  66. def takeWhile(f: (O) ⇒ Boolean): decode.StreamDecoder[O]

    Decode values as long as the predicate tests true.

    Decode values as long as the predicate tests true.

    Definition Classes
    StreamDecoder
  67. final def through[B](p: Pipe[Pure, O, B]): decode.StreamDecoder[B]

    Transform the output of this StreamDecoder using the given single-input stream transducer.

    Transform the output of this StreamDecoder using the given single-input stream transducer.

    Definition Classes
    StreamDecoder
  68. final def through2[B, C](d: decode.StreamDecoder[B])(t: Pipe2[Pure, O, B, C]): decode.StreamDecoder[C]

    Combine the output of this StreamDecoder with another streaming decoder, using the given binary stream transducer.

    Combine the output of this StreamDecoder with another streaming decoder, using the given binary stream transducer. Note that both d and this will operate on the same input BitVector, so this combinator is more useful for expressing alternation between two decoders.

    Definition Classes
    StreamDecoder
  69. def toString(): String
    Definition Classes
    AnyRef → Any
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. def widen[B](f: (I) ⇒ B, g: (B) ⇒ Attempt[I]): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  74. def widenOpt[B](f: (I) ⇒ B, g: (B) ⇒ Option[I]): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  75. def widenOptc[B](f: (I) ⇒ B)(g: (B) ⇒ Option[I]): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  76. def widenc[B](f: (I) ⇒ B)(g: (B) ⇒ Attempt[I]): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  77. def withFilter(f: (O) ⇒ Boolean): decode.StreamDecoder[O]

    Skip any decoded values for which the predicate tests false.

    Skip any decoded values for which the predicate tests false.

    Definition Classes
    StreamDecoder
  78. def xmap[B](f: (I) ⇒ B, g: (B) ⇒ I): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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
  79. final def xmapc[B](f: (I) ⇒ B)(g: (B) ⇒ I): encode.StreamEncoder[B]

    Transform the input type of this StreamEncoder.

    Transform the input type of this StreamEncoder.

    Definition Classes
    StreamEncoder
  80. final def |[A2 >: O](d: decode.StreamDecoder[A2]): decode.StreamDecoder[A2]

    Operator alias for this.or(d).

    Operator alias for this.or(d).

    Definition Classes
    StreamDecoder
  81. def →[B](y: B): (StreamGenCodec[I, O], B)
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to ArrowAssoc[StreamGenCodec[I, O]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def xmapc[B](f: (I) ⇒ B)(g: (B) ⇒ I): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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:
    (streamGenCodec: TransformSyntax[StreamEncoder, I]).xmapc(f)(g)
    Definition Classes
    TransformSyntax

Deprecated Value Members

  1. def pxmap[B](f: (I) ⇒ B, g: (B) ⇒ Option[I]): StreamEncoder[B]
    Implicit
    This member is added by an implicit conversion from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I] 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 decode.StreamDecoder[O]

Inherited from encode.StreamEncoder[I]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion TransformSyntax from StreamGenCodec[I, O] to TransformSyntax[StreamEncoder, I]

Inherited by implicit conversion any2stringadd from StreamGenCodec[I, O] to any2stringadd[StreamGenCodec[I, O]]

Inherited by implicit conversion StringFormat from StreamGenCodec[I, O] to StringFormat[StreamGenCodec[I, O]]

Inherited by implicit conversion Ensuring from StreamGenCodec[I, O] to Ensuring[StreamGenCodec[I, O]]

Inherited by implicit conversion ArrowAssoc from StreamGenCodec[I, O] to ArrowAssoc[StreamGenCodec[I, O]]

Ungrouped