package compression
- Alphabetic
- Public
- Protected
Type Members
- 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 forAsync[F]
by importingfs2.io.compression._
. - sealed trait DeflateParams extends AnyRef
Deflate algorithm parameters.
- 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.
- sealed trait InflateParams extends AnyRef
Inflate algorithm parameters.
Value Members
- object Compression extends CompressionCompanionPlatform
- object DeflateParams
- object InflateParams
- object ZLibParams
- object checksum
Provides various checksums as pipes.