Packages

p

fs2

compression

package compression

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait Compression[F[_]] extends CompressionPlatform[F]

    Provides the capability to compress/decompress using deflate and gzip.

    Provides the capability to compress/decompress using deflate and gzip. On JVM an instance is available given a Sync[F]. On Node.js an instance is available for Async[F] by importing fs2.io.compression._.

  2. sealed trait DeflateParams extends AnyRef

    Deflate algorithm parameters.

  3. case class GunzipResult[F[_]](content: Stream[F, Byte], modificationTime: Option[Instant] = None, fileName: Option[String] = None, comment: Option[String] = None) extends Product with Serializable

    Gunzip decompression results including file properties and decompressed content stream, used as follows: stream .through(gunzip[IO]()) .flatMap { gunzipResult => // Access properties here.

    Gunzip decompression results including file properties and decompressed content stream, used as follows: stream .through(gunzip[IO]()) .flatMap { gunzipResult => // Access properties here. gunzipResult.content }

    content

    Uncompressed content stream.

    modificationTime

    Modification time of compressed file.

    fileName

    File name.

    comment

    File comment.

  4. sealed trait InflateParams extends AnyRef

    Inflate algorithm parameters.

Value Members

  1. object Compression extends CompressionCompanionPlatform
  2. object DeflateParams
  3. object InflateParams
  4. object ZLibParams
  5. object checksum

    Provides various checksums as pipes.

Ungrouped