Packages

abstract class Compressor extends AnyRef

A stateful object representing ongoing compression.

Annotations
@InternalApi() @deprecated
Deprecated

(Since version Akka HTTP 10.2.0) Compressor is internal API and will be moved or removed in the future.

Source
Encoder.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
DeflateCompressor, NoCodingCompressor
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Compressor
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Compressor()

Abstract Value Members

  1. abstract def compress(input: ByteString): ByteString

    Compresses the given input and returns compressed data.

    Compresses the given input and returns compressed data. The implementation can and will choose to buffer output data to improve compression. Use flush or compressAndFlush to make sure that all input data has been compressed and pending output data has been returned.

  2. abstract def compressAndFinish(input: ByteString): ByteString

    Combines compress + finish

  3. abstract def compressAndFlush(input: ByteString): ByteString

    Combines compress + flush

  4. abstract def finish(): ByteString

    Closes this compressed stream and return the remaining compressed data.

    Closes this compressed stream and return the remaining compressed data. After calling this method, this Compressor cannot be used any further.

  5. abstract def flush(): ByteString

    Flushes any output data and returns the currently remaining compressed data.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Compressor toany2stringadd[Compressor] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Compressor, B)
    Implicit
    This member is added by an implicit conversion from Compressor toArrowAssoc[Compressor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (Compressor) => Boolean, msg: => Any): Compressor
    Implicit
    This member is added by an implicit conversion from Compressor toEnsuring[Compressor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Compressor) => Boolean): Compressor
    Implicit
    This member is added by an implicit conversion from Compressor toEnsuring[Compressor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Compressor
    Implicit
    This member is added by an implicit conversion from Compressor toEnsuring[Compressor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Compressor
    Implicit
    This member is added by an implicit conversion from Compressor toEnsuring[Compressor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Compressor toStringFormat[Compressor] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (Compressor, B)
    Implicit
    This member is added by an implicit conversion from Compressor toArrowAssoc[Compressor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromCompressor to any2stringadd[Compressor]

Inherited by implicit conversion StringFormat fromCompressor to StringFormat[Compressor]

Inherited by implicit conversion Ensuring fromCompressor to Ensuring[Compressor]

Inherited by implicit conversion ArrowAssoc fromCompressor to ArrowAssoc[Compressor]

Ungrouped