fs2.compression

Type members

Classlikes

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

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._.

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._.

Companion
object
object Compression extends CompressionCompanionPlatform
Companion
class
sealed

Deflate algorithm parameters.

Deflate algorithm parameters.

Companion
object
Companion
class
case
class GunzipResult[F[_]](content: Stream[F, Byte], modificationTime: Option[Instant], fileName: Option[String], comment: Option[String])

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

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

Value Params
comment

File comment.

content

Uncompressed content stream.

fileName

File name.

modificationTime

Modification time of compressed file.

sealed

Inflate algorithm parameters.

Inflate algorithm parameters.

Companion
object
Companion
class
object ZLibParams
object checksum

Provides various checksums as pipes.

Provides various checksums as pipes.