object Compression

Source
Compression.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Compression
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final val ZstdDecompressMaxBlockSize: Int

    The maximum block size used by zstd decompression

    The maximum block size used by zstd decompression

    Since

    2.0.0

  5. final val ZstdDefaultCompressionLevel: Int

    The zstd default compression level

    The zstd default compression level

    Since

    2.0.0

  6. final val ZstdMaxCompressionLevel: Int

    The maximum compression level supported by zstd

    The maximum compression level supported by zstd

    Since

    2.0.0

  7. final val ZstdMaxWindowLog: Int

    The maximum window log supported by zstd compression on 64-bit platforms

    The maximum window log supported by zstd compression on 64-bit platforms

    Since

    2.0.0

  8. final val ZstdMinCompressionLevel: Int

    The minimum compression level supported by zstd

    The minimum compression level supported by zstd

    Since

    2.0.0

  9. final val ZstdMinWindowLog: Int

    The minimum window log supported by zstd compression

    The minimum window log supported by zstd compression

    Since

    2.0.0

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  12. def deflate(level: Int, nowrap: Boolean, autoFlush: Boolean): Flow[ByteString, ByteString, NotUsed]

    Same as deflate with configurable level, nowrap and autoFlush.

    Same as deflate with configurable level, nowrap and autoFlush.

    level

    Compression level (0-9)

    nowrap

    if true then use GZIP compatible compression

    autoFlush

    If true will automatically flush after every single element in the stream.

    Since

    1.3.0

  13. def deflate(level: Int, nowrap: Boolean): Flow[ByteString, ByteString, NotUsed]

    Same as deflate with configurable level and nowrap

    Same as deflate with configurable level and nowrap

    level

    Compression level (0-9)

    nowrap

    if true then use GZIP compatible compression

  14. def deflate: Flow[ByteString, ByteString, NotUsed]

    Creates a flow that deflate-compresses a stream of ByteString.

    Creates a flow that deflate-compresses a stream of ByteString. Note that the compressor will flush after every single element in stream so that it is guaranteed that every pekko.util.ByteString coming out of the flow can be fully decompressed without waiting for additional data. This may come at a compression performance cost for very small chunks.

  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  18. def gzip(level: Int, autoFlush: Boolean): Flow[ByteString, ByteString, NotUsed]

    Same as gzip with a custom level and configurable flush mode.

    Same as gzip with a custom level and configurable flush mode.

    level

    Compression level (0-9)

    autoFlush

    If true will automatically flush after every single element in the stream.

    Since

    1.3.0

  19. def gzip(level: Int): Flow[ByteString, ByteString, NotUsed]

    Same as gzip with a custom level.

    Same as gzip with a custom level.

    level

    Compression level (0-9)

  20. def gzip: Flow[ByteString, ByteString, NotUsed]

    Creates a flow that gzip-compresses a stream of ByteStrings.

    Creates a flow that gzip-compresses a stream of ByteStrings. Note that the compressor will flush after every single element in stream so that it is guaranteed that every pekko.util.ByteString coming out of the flow can be fully decompressed without waiting for additional data. This may come at a compression performance cost for very small chunks.

  21. def gzipDecompress(maxBytesPerChunk: Int): Flow[ByteString, ByteString, NotUsed]

    Creates a Flow that decompresses gzip-compressed stream of data.

    Creates a Flow that decompresses gzip-compressed stream of data.

    maxBytesPerChunk

    Maximum length of the output pekko.util.ByteString chunk.

    Since

    1.3.0

  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. def inflate(maxBytesPerChunk: Int, nowrap: Boolean): Flow[ByteString, ByteString, NotUsed]

    Same as inflate with configurable maximum output length and nowrap

    Same as inflate with configurable maximum output length and nowrap

    maxBytesPerChunk

    Maximum length of the output pekko.util.ByteString chunk.

    nowrap

    if true then use GZIP compatible decompression

  24. def inflate(maxBytesPerChunk: Int): Flow[ByteString, ByteString, NotUsed]

    Creates a Flow that decompresses deflate-compressed stream of data.

    Creates a Flow that decompresses deflate-compressed stream of data.

    maxBytesPerChunk

    Maximum length of the output pekko.util.ByteString chunk.

  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. def zstd(settings: ZstdCompressionSettings): Flow[ByteString, ByteString, NotUsed]

    Same as zstd with the given settings, see pekko.stream.ZstdCompressionSettings for the level, flush mode, window size and dictionary.

    Same as zstd with the given settings, see pekko.stream.ZstdCompressionSettings for the level, flush mode, window size and dictionary.

    Annotations
    @ApiMayChange()
    Since

    2.0.0

  35. def zstd(level: Int, dictionary: Optional[ZstdDictionary]): Flow[ByteString, ByteString, NotUsed]

    Same as zstd with a custom level and an optional dictionary.

    Same as zstd with a custom level and an optional dictionary.

    level

    The compression level, must be greater or equal to ZstdMinCompressionLevel and less than or equal to ZstdMaxCompressionLevel

    dictionary

    An optional dictionary that can be used for compression

    Annotations
    @ApiMayChange()
    Since

    2.0.0

  36. def zstd: Flow[ByteString, ByteString, NotUsed]

    Creates a flow that zstd-compresses a stream of ByteStrings, with the default compression level.

    Creates a flow that zstd-compresses a stream of ByteStrings, with the default compression level.

    Annotations
    @ApiMayChange()
    Since

    2.0.0

  37. def zstdDecompress(settings: ZstdDecompressionSettings): Flow[ByteString, ByteString, NotUsed]

    Same as zstdDecompress with the given settings, see pekko.stream.ZstdDecompressionSettings for the chunk size, window limit and dictionary.

    Same as zstdDecompress with the given settings, see pekko.stream.ZstdDecompressionSettings for the chunk size, window limit and dictionary.

    Annotations
    @ApiMayChange()
    Since

    2.0.0

  38. def zstdDecompress(maxBytesPerChunk: Int): Flow[ByteString, ByteString, NotUsed]

    Creates a flow that zstd-decompresses a stream of ByteStrings.

    Creates a flow that zstd-decompresses a stream of ByteStrings.

    maxBytesPerChunk

    The maximum length of the emitted ByteStrings

    Annotations
    @ApiMayChange()
    Since

    2.0.0

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped