fs2-docs/fs2.interop.scodec/StreamEncoder

StreamEncoder

final class StreamEncoder[A]

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

Companion:
object
Source:
StreamEncoder.scala
class Object
trait Matchable
class Any

Value members

Concrete methods

def ++(that: => StreamEncoder[A]): StreamEncoder[A]

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

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

Source:
StreamEncoder.scala
def encode[F[_] : RaiseThrowable](in: Stream[F, A]): Stream[F, BitVector]

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

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

Source:
StreamEncoder.scala
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.

Source:
StreamEncoder.scala
def repeat: StreamEncoder[A]

Encodes values as long as there are more inputs.

Encodes values as long as there are more inputs.

Source:
StreamEncoder.scala
def toPipe[F[_] : RaiseThrowable]: (F, A) => BitVector

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

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

Source:
StreamEncoder.scala
def toPipeByte[F[_] : RaiseThrowable]: (F, A) => Byte

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

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

Source:
StreamEncoder.scala
def xmapc[B](f: A => B)(g: B => A): StreamEncoder[B]

Transform the input type of this StreamEncoder.

Transform the input type of this StreamEncoder.

Source:
StreamEncoder.scala