stream

Type Members

1. final case class CodecError(err: Err) extends Exception with NoStackTrace with Product with Serializable

   

   Lifts an scodec.Err in to an exception.

2. final class StreamDecoder[+A] extends AnyRef

   

   Supports binary decoding of a stream that emits elements as they are decoded.

   Supports binary decoding of a stream that emits elements as they are decoded.

   The main purpose of using a StreamDecoder over an scodec.Decoder is mixing decoding with processing. For example, scodec.codecs.vector(decoderA): Decoder[Vector[A]] could be used to decode a bit stream but the decoded Vector[A] would not be emitted until the end of the bit stream. With StreamDecoder.many(decoderA): StreamDecoder[A], each decoded A value is emitted as soon as it is decoded.

   The StreamDecoder companion has various constructors -- most importantly, once and many, that allow a Decoder[A] to be lifted to a StreamDecoder[A].

   Given a StreamDecoder[A], a bit stream can be decoded via the decode method or by calling a variant of toPipe.

3. 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])]].