scodec.stream.codec

StreamCodec

trait StreamCodec[A] extends StreamGenCodec[A, A]

Source
StreamCodec.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StreamCodec
  2. StreamGenCodec
  3. StreamDecoder
  4. StreamEncoder
  5. AnyRef
  6. Any
Implicitly
  1. by TransformSyntax
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decoder: Process[Cursor, A]

    The Process backing this StreamDecoder.

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

    Definition Classes
    StreamDecoder
  2. 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.

    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 information
    This member is added by an implicit conversion from StreamCodec[A] to any2stringadd[StreamCodec[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. final def ++[A2 >: A](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 ++[A2 <: A](e: encode.StreamEncoder[A2]): encode.StreamEncoder[A2]

    Run this StreamEncoder, followed by e.

    Run this StreamEncoder, followed by e.

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

    Implicit information
    This member is added by an implicit conversion from StreamCodec[A] to ArrowAssoc[StreamCodec[A]] 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[A, B]): StreamCodec[B]

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

    Definition Classes
    Any
  10. def chunk(bitsPerChunk: Long): encode.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.

    Definition Classes
    StreamEncoder
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. final def collect[B](pf: PartialFunction[A, 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
  13. final def contramap[A0](f0: (A0) ⇒ A): encode.StreamEncoder[A0]

    Transform the input type of this StreamEncoder.

    Transform the input type of this StreamEncoder.

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

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

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

    Definition Classes
    StreamEncoder
  15. final def decode(bits: ⇒ BitVector): Process[Task, A]

    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
  16. def decodeAllValid(bits: ⇒ BitVector): Vector[A]

    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
  17. final def decodeAsyncResource[R](acquire: Task[R])(read: (R) ⇒ BitVector, release: (R) ⇒ Task[Unit]): Process[Task, A]

    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 Process[Task,A] is finished being consumed. The acquire and release actions may be asynchronous.

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

    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 Process[Task,A] is consumed.

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

    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 Process[Task,A] is consumed.

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

    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 Process[Task,A] is consumed.

    Definition Classes
    StreamDecoder
  21. final def decodeResource[R](acquire: ⇒ R)(read: (R) ⇒ BitVector, release: (R) ⇒ Unit): Process[Task, A]

    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 Process[Task,A] is finished being consumed. If the acquire and release actions are asynchronous, use decodeAsyncResource.

    Definition Classes
    StreamDecoder
  22. def drop(n: Int): decode.StreamDecoder[A]

    Ignore the first n decoded values.

    Ignore the first n decoded values.

    Definition Classes
    StreamDecoder
  23. def dropWhile(f: (A) ⇒ Boolean): decode.StreamDecoder[A]

    Ignore decoded values as long as the predicate tests true.

    Ignore decoded values as long as the predicate tests true.

    Definition Classes
    StreamDecoder
  24. final def edit[B](f: (Process[Cursor, A]) ⇒ Process[Cursor, B]): decode.StreamDecoder[B]

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

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

    Definition Classes
    StreamDecoder
  25. final def edit[A2](f: (Process1[A, BitVector]) ⇒ Process1[A2, BitVector]): encode.StreamEncoder[A2]

    Modify the Process1 backing this StreamEncoder.

    Modify the Process1 backing this StreamEncoder.

    Definition Classes
    StreamEncoder
  26. def editDecoder[O2](f: (StreamDecoder[A]) ⇒ StreamDecoder[O2]): StreamGenCodec[A, O2]

    Definition Classes
    StreamGenCodec
  27. def editEncoder[I2](f: (StreamEncoder[A]) ⇒ StreamEncoder[I2]): StreamGenCodec[I2, A]

    Definition Classes
    StreamGenCodec
  28. final def encode[F[_]](in: Process[F, A]): Process[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
  29. 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.

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

    Definition Classes
    StreamEncoder
  30. def ensuring(cond: (StreamCodec[A]) ⇒ Boolean, msg: ⇒ Any): StreamCodec[A]

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

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

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from StreamCodec[A] to TransformSyntax[StreamCodec, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[StreamCodec] is in scope.
    Definition Classes
    TransformSyntax
  37. def filter(f: (A) ⇒ Boolean): decode.StreamDecoder[A]

    Skip any decoded values for which the predicate tests false.

    Skip any decoded values for which the predicate tests false.

    Definition Classes
    StreamDecoder
  38. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def firstAfter(f: (A) ⇒ Boolean): decode.StreamDecoder[A]

    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
  40. final def flatMap[B](f: (A) ⇒ 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
  41. final def flatMapP[B](f: (A) ⇒ Process[Cursor, B]): decode.StreamDecoder[B]

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

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

    Definition Classes
    StreamDecoder
  42. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from StreamCodec[A] to StringFormat[StreamCodec[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  43. def fuse[II <: A, OO >: A](implicit ev: =:=[OO, II]): StreamCodec[OO]

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

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

    Definition Classes
    StreamGenCodec
  44. final def getClass(): Class[_]

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

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

    Definition Classes
    Any
  47. def isolate(numberOfBits: Long): decode.StreamDecoder[A]

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

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

    Definition Classes
    StreamDecoder
  48. def isolateBytes(numberOfBytes: Long): decode.StreamDecoder[A]

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

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

    Definition Classes
    StreamDecoder
  49. def many: StreamCodec[A]

    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
    StreamCodecStreamGenCodecStreamDecoderStreamEncoder
  50. def many1: decode.StreamDecoder[A]

    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
  51. final def map[B](f: (A) ⇒ 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
  52. def mapBits(f: (BitVector) ⇒ BitVector): encode.StreamEncoder[A]

    Transform the output BitVector values produced by this encoder.

    Transform the output BitVector values produced by this encoder.

    Definition Classes
    StreamEncoder
  53. final def mapEither[B](f: (A) ⇒ \/[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
  54. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): StreamCodec[B]

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

    Definition Classes
    AnyRef
  56. def nonEmpty(errIfEmpty: Err): decode.StreamDecoder[A]

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

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

    Definition Classes
    StreamDecoder
  57. final def notify(): Unit

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

    Definition Classes
    AnyRef
  59. final def onComplete[A2 >: A](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 scalaz.stream.Process.onComplete.

    Definition Classes
    StreamDecoder
  60. final def or[A2 >: A](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
  61. def peek: decode.StreamDecoder[A]

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

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

    Definition Classes
    StreamDecoder
  62. final def pipe[B](p: Process1[A, 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
  63. def pipeBits(f: Process1[BitVector, BitVector]): encode.StreamEncoder[A]

    Statefully transform the output BitVector values produced by this encoder.

    Statefully transform the output BitVector values produced by this encoder.

    Definition Classes
    StreamEncoder
  64. val self: StreamCodec[A]

    Implicit information
    This member is added by an implicit conversion from StreamCodec[A] to TransformSyntax[StreamCodec, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[StreamCodec] is in scope.
    Definition Classes
    TransformSyntax
  65. def sepBy[B](implicit B: Lazy[Decoder[B]]): decode.StreamDecoder[A]

    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
  66. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  67. def take(n: Int): StreamCodec[A]

    Decode at most n values using this StreamDecoder.

    Decode at most n values using this StreamDecoder.

    Definition Classes
    StreamCodecStreamGenCodecStreamDecoderStreamEncoder
  68. def takeWhile(f: (A) ⇒ Boolean): decode.StreamDecoder[A]

    Decode values as long as the predicate tests true.

    Decode values as long as the predicate tests true.

    Definition Classes
    StreamDecoder
  69. final def tee[B, C](d: decode.StreamDecoder[B])(t: Tee[A, 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
  70. def toString(): String

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

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from StreamCodec[A] to TransformSyntax[StreamCodec, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[StreamCodec] is in scope.
    Definition Classes
    TransformSyntax
  76. def withFilter(f: (A) ⇒ Boolean): decode.StreamDecoder[A]

    Skip any decoded values for which the predicate tests false.

    Skip any decoded values for which the predicate tests false.

    Definition Classes
    StreamDecoder
  77. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): StreamCodec[B]

    Implicit information
    This member is added by an implicit conversion from StreamCodec[A] to TransformSyntax[StreamCodec, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[StreamCodec] is in scope.
    Definition Classes
    TransformSyntax
  78. final def |[A2 >: A](d: decode.StreamDecoder[A2]): decode.StreamDecoder[A2]

    Operator alias for this.or(d).

    Operator alias for this.or(d).

    Definition Classes
    StreamDecoder
  79. final def |>[B](p: Process1[A, B]): decode.StreamDecoder[B]

    Alias for this pipe p.

    Alias for this pipe p.

    Definition Classes
    StreamDecoder
  80. def [B](y: B): (StreamCodec[A], B)

    Implicit information
    This member is added by an implicit conversion from StreamCodec[A] to ArrowAssoc[StreamCodec[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]): StreamCodec[B]

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

    (Since version 1.7.0) Use widenOpt instead

Inherited from StreamGenCodec[A, A]

Inherited from decode.StreamDecoder[A]

Inherited from encode.StreamEncoder[A]

Inherited from AnyRef

Inherited from Any

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

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

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

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

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

Ungrouped