fs2-docs
3.10.2
API
Generated with
fs2-docs/fs2/fs2.compression

fs2.compression

package fs2.compression

Members list

Type members

Classlikes

sealed trait Compression[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._.

Attributes

Companion
object
Source
Compression.scala
Supertypes
class Object
trait Matchable
class Any
object Compression

Attributes

Companion
trait
Source
Compression.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait DeflateParams

Deflate algorithm parameters.

Deflate algorithm parameters.

Attributes

Companion
object
Source
DeflateParams.scala
Supertypes
class Object
trait Matchable
class Any
object DeflateParams

Attributes

Companion
trait
Source
DeflateParams.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
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(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 }

Value parameters

comment

File comment.

content

Uncompressed content stream.

fileName

File name.

modificationTime

Modification time of compressed file.

Attributes

Source
GunzipResult.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait InflateParams

Inflate algorithm parameters.

Inflate algorithm parameters.

Attributes

Companion
object
Source
InflateParams.scala
Supertypes
class Object
trait Matchable
class Any
object InflateParams

Attributes

Companion
trait
Source
InflateParams.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object ZLibParams

Attributes

Source
ZLibParams.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ZLibParams.type
object checksum

Provides various checksums as pipes.

Provides various checksums as pipes.

Attributes

Source
checksum.scala
Supertypes
class Object
trait Matchable
class Any
Self type
checksum.type
Generated with