Packages

object Coders

Annotations
@nowarn()
Source
Coders.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Coders
  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. val DefaultCoders: Seq[Coder]
  5. def Deflate(messageFilter: (HttpMessage) => Boolean = Encoder.DefaultFilter, compressionLevel: Int = DeflateCompressor.DefaultCompressionLevel): Coder
  6. def Deflate: Coder
  7. def Gzip(messageFilter: (HttpMessage) => Boolean = Encoder.DefaultFilter, compressionLevel: Int = GzipCompressor.DefaultCompressionLevel): Coder
  8. def Gzip: Coder
  9. def NoCoding: Coder
  10. def Zstd(messageFilter: (HttpMessage) => Boolean = Encoder.DefaultFilter, compressionLevel: Int = pekko.http.scaladsl.coding.Zstd.DefaultCompressionLevel, windowLogMax: Int = pekko.http.scaladsl.coding.Zstd.DefaultWindowLogMax): Coder

    A coder for the 'zstd' encoding with a custom message filter, compression level and decoder window limit, see Zstd.

    A coder for the 'zstd' encoding with a custom message filter, compression level and decoder window limit, see Zstd.

    compressionLevel

    must be between Compression.ZstdMinCompressionLevel and Compression.ZstdMaxCompressionLevel of pekko-stream

    windowLogMax

    the log2 of the largest window that the decoder accepts, 23 (8 MB, the limit of RFC 9659) by default. It must be 0 or between Compression.ZstdMinWindowLog and Compression.ZstdMaxWindowLog of pekko-stream; 0 uses the limit of libzstd (128 MB) and also works with versions of zstd-jni older than 1.5.7-25

    Since

    2.0.0

  11. def Zstd: Coder

    A coder for the 'zstd' encoding.

    A coder for the 'zstd' encoding. It is not one of the DefaultCoders, as it needs the optional com.github.luben:zstd-jni dependency on the classpath, version 1.5.7-25 or later.

    Following RFC 9659, it does not compress with a window larger than 8 MB, and does not decode frames that need a larger window, so that a peer cannot make it allocate more memory than that for one message.

    Since

    2.0.0

  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  14. def decodeMessage(message: HttpMessage, decoders: Seq[Decoder] = DefaultCoders): Self

    Decodes the message with the one of decoders whose encoding matches the message's Content-Encoding header, for example to decode a response on the client side without checking its encoding first.

    Decodes the message with the one of decoders whose encoding matches the message's Content-Encoding header, for example to decode a response on the client side without checking its encoding first.

    The message is returned unchanged if it has no Content-Encoding header, if none of decoders matches its encoding, or if the header lists more than one encoding. In the last two cases the Content-Encoding header is kept, so message.encoding shows that the entity is still encoded.

    decoders

    the decoders to choose from, Zstd is not one of the DefaultCoders

    Since

    2.0.0

  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 hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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