akka.http.scaladsl.coding

GzipDecompressor

class GzipDecompressor extends DeflateDecompressorBase

Source
Gzip.scala
Linear Supertypes
DeflateDecompressorBase, ByteStringParserStage[ByteString], StatefulStage[ByteString, ByteString], PushPullStage[ByteString, ByteString], AbstractStage[ByteString, ByteString, SyncDirective, SyncDirective, Context[ByteString], LifecycleContext], Stage[ByteString, ByteString], AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GzipDecompressor
  2. DeflateDecompressorBase
  3. ByteStringParserStage
  4. StatefulStage
  5. PushPullStage
  6. AbstractStage
  7. Stage
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GzipDecompressor(maxBytesPerChunk: Int = Decoder.MaxBytesPerChunkDefault)

Type Members

  1. trait ByteReadingState extends IntermediateState

    A stage that tries to read from a side-effecting ByteReader.

    A stage that tries to read from a side-effecting ByteReader. If a buffer underrun occurs the previous data is saved and the reading process is restarted from the beginning once more data was received.

    As read may be called several times for the same prefix of data, make sure not to manipulate any state during reading from the ByteReader.

    Definition Classes
    ByteStringParserStage
  2. case class Inflate()(data: ByteString) extends IntermediateState with Product with Serializable

    Inflate

  3. abstract class IntermediateState extends impl.util.ByteStringParserStage.State

    Derive a stage from IntermediateState and then call pull(ctx) instead of ctx.pull() to have truncation errors reported.

    Derive a stage from IntermediateState and then call pull(ctx) instead of ctx.pull() to have truncation errors reported.

    Definition Classes
    ByteStringParserStage
  4. abstract class State extends StageState[In, Out]

    Scala API

  5. case class TryAgain extends IntermediateState with Product with Serializable

    Definition Classes
    ByteStringParserStage

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (GzipDecompressor, B)

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to ArrowAssoc[GzipDecompressor] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. object Initial extends State with Product with Serializable

    No bytes were received yet

  9. object ReadHeaders extends IntermediateState with ByteReadingState with Product with Serializable

    Reading the header bytes

  10. object ReadTrailer extends IntermediateState with ByteReadingState with Product with Serializable

    Reading the trailer

  11. object StartInflate extends IntermediateState with Product with Serializable

    Start inflating

  12. def afterBytesRead(buffer: Array[Byte], offset: Int, length: Int): Unit

    Attributes
    protected
    Definition Classes
    GzipDecompressorDeflateDecompressorBase
  13. def afterInflate: State

    Attributes
    protected
    Definition Classes
    GzipDecompressorDeflateDecompressorBase
  14. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  15. final def become(state: StageState[ByteString, ByteString]): Unit

    Change the behavior to another StageState.

    Change the behavior to another StageState.

    Definition Classes
    StatefulStage
  16. def becomeWithRemaining(next: State, remaining: ByteString, ctx: Context[ByteString]): SyncDirective

    Definition Classes
    DeflateDecompressorBase
  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. var crc32: CRC32

  19. def createInflater(): Inflater

    Attributes
    protected
    Definition Classes
    GzipDecompressorDeflateDecompressorBase
  20. final def current: StageState[ByteString, ByteString]

    Current state.

    Current state.

    Definition Classes
    StatefulStage
  21. def decide(t: Throwable): Directive

    If an exception is thrown from #onPush this method is invoked to decide how to handle the exception.

    If an exception is thrown from #onPush this method is invoked to decide how to handle the exception. By default this method returns Supervision.Stop.

    If an exception is thrown from #onPull the stream will always be completed with failure, because it is not always possible to recover from that state. In concrete stages it is of course possible to use ordinary try-catch-recover inside onPull when it is know how to recover from such exceptions.

    Definition Classes
    AbstractStage
  22. final def emit(iter: Iterator[ByteString], ctx: Context[ByteString], nextState: StageState[ByteString, ByteString]): SyncDirective

    Java API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams and after that change behavior.

    Java API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams and after that change behavior.

    Definition Classes
    StatefulStage
  23. final def emit(iter: Iterator[ByteString], ctx: Context[ByteString], nextState: StageState[ByteString, ByteString]): SyncDirective

    Scala API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams and after that change behavior.

    Scala API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams and after that change behavior.

    Definition Classes
    StatefulStage
  24. final def emit(iter: Iterator[ByteString], ctx: Context[ByteString]): SyncDirective

    Java API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams.

    Java API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams.

    Definition Classes
    StatefulStage
  25. final def emit(iter: Iterator[ByteString], ctx: Context[ByteString]): SyncDirective

    Scala API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams.

    Scala API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams.

    Definition Classes
    StatefulStage
  26. final def emitAndFinish(iter: Iterator[ByteString], ctx: Context[ByteString]): SyncDirective

    Java API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams and after that finish (complete downstreams, cancel upstreams).

    Java API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams and after that finish (complete downstreams, cancel upstreams).

    Definition Classes
    StatefulStage
  27. final def emitAndFinish(iter: Iterator[ByteString], ctx: Context[ByteString]): SyncDirective

    Scala API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams and after that finish (complete downstreams, cancel upstreams).

    Scala API: Can be used from StageState#onPush or StageState#onPull to push more than one element downstreams and after that finish (complete downstreams, cancel upstreams).

    Definition Classes
    StatefulStage
  28. def ensuring(cond: (GzipDecompressor) ⇒ Boolean, msg: ⇒ Any): GzipDecompressor

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to Ensuring[GzipDecompressor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: (GzipDecompressor) ⇒ Boolean): GzipDecompressor

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to Ensuring[GzipDecompressor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: Boolean, msg: ⇒ Any): GzipDecompressor

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to Ensuring[GzipDecompressor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. def ensuring(cond: Boolean): GzipDecompressor

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to Ensuring[GzipDecompressor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  32. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  33. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  34. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  36. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  37. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  38. val inflater: Inflater

    Definition Classes
    DeflateDecompressorBase
  39. def initial: State

    Concrete subclass must return the initial behavior from this method.

    Concrete subclass must return the initial behavior from this method.

    **Warning:** This method must not be implemented as val.

    Definition Classes
    GzipDecompressorStatefulStage
  40. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  41. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  42. final def notify(): Unit

    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  44. def onDownstreamFinish(ctx: Context[ByteString]): TerminationDirective

    onDownstreamFinish is called when downstream has cancelled.

    onDownstreamFinish is called when downstream has cancelled.

    By default the cancel signal is immediately propagated with akka.stream.stage.Context#finish.

    Definition Classes
    AbstractStage
  45. final def onPull(ctx: Context[ByteString]): SyncDirective

    Invokes current state.

    Invokes current state.

    Definition Classes
    StatefulStageAbstractStage
  46. final def onPush(elem: ByteString, ctx: Context[ByteString]): SyncDirective

    Invokes current state.

    Invokes current state.

    Definition Classes
    StatefulStageAbstractStage
  47. def onTruncation(ctx: Context[ByteString]): SyncDirective

    Attributes
    protected
    Definition Classes
    GzipDecompressor → ByteStringParserStage
  48. def onUpstreamFailure(cause: Throwable, ctx: Context[ByteString]): TerminationDirective

    onUpstreamFailure is called when upstream has signaled that the stream is completed with failure.

    onUpstreamFailure is called when upstream has signaled that the stream is completed with failure. It is not called if #onPull or #onPush of the stage itself throws an exception.

    Note that elements that were emitted by upstream before the failure happened might not have been received by this stage when onUpstreamFailure is called, i.e. failures are not backpressured and might be propagated as soon as possible.

    Here you cannot call akka.stream.stage.Context#push, because there might not be any demand from downstream. To emit additional elements before terminating you can use akka.stream.stage.Context#absorbTermination and push final elements from #onPull. The stage will then be in finishing state, which can be checked with akka.stream.stage.Context#isFinishing.

    Definition Classes
    AbstractStage
  49. def onUpstreamFinish(ctx: Context[ByteString]): TerminationDirective

    onUpstreamFinish is called when upstream has signaled that the stream is successfully completed.

    onUpstreamFinish is called when upstream has signaled that the stream is successfully completed. Here you cannot call akka.stream.stage.Context#push, because there might not be any demand from downstream. To emit additional elements before terminating you can use akka.stream.stage.Context#absorbTermination and push final elements from #onPull. The stage will then be in finishing state, which can be checked with akka.stream.stage.Context#isFinishing.

    By default the finish signal is immediately propagated with akka.stream.stage.Context#finish.

    *IMPORTANT NOTICE:* this signal is not back-pressured, it might arrive from upstream even though the last action by this stage was a “push”.

    Definition Classes
    GzipDecompressorStatefulStageAbstractStage
  50. def postStop(): Unit

    User overridable callback.

    User overridable callback.

    Is called after the Stages final action is performed. // TODO need better wording here Empty default implementation.

    Definition Classes
    AbstractStage
    Annotations
    @throws( classOf[Exception] )
  51. def preStart(ctx: LifecycleContext): Unit

    User overridable callback.

    User overridable callback.

    It is called before any other method defined on the Stage. Empty default implementation.

    Definition Classes
    AbstractStage
    Annotations
    @throws( classOf[Exception] )
  52. def restart(): Stage[ByteString, ByteString]

    Used to create a fresh instance of the stage after an error resulting in a Supervision.Restart directive.

    Used to create a fresh instance of the stage after an error resulting in a Supervision.Restart directive. By default it will return the same instance untouched, so you must override it if there are any state that should be cleared before restarting, e.g. by returning a new instance.

    Definition Classes
    AbstractStage
  53. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  54. final def terminationEmit(iter: Iterator[ByteString], ctx: Context[ByteString]): TerminationDirective

    Java API: Can be used from #onUpstreamFinish or #onUpstreamFailure to push final elements downstreams.

    Java API: Can be used from #onUpstreamFinish or #onUpstreamFailure to push final elements downstreams.

    Definition Classes
    StatefulStage
  55. final def terminationEmit(iter: Iterator[ByteString], ctx: Context[ByteString]): TerminationDirective

    Scala API: Can be used from #onUpstreamFinish to push final elements downstreams before completing the stream successfully.

    Scala API: Can be used from #onUpstreamFinish to push final elements downstreams before completing the stream successfully. Note that if this is used from #onUpstreamFailure the failure will be absorbed and the stream will be completed successfully.

    Definition Classes
    StatefulStage
  56. def toString(): String

    Definition Classes
    AnyRef → Any
  57. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. def [B](y: B): (GzipDecompressor, B)

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to ArrowAssoc[GzipDecompressor] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (gzipDecompressor: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (gzipDecompressor: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: GzipDecompressor

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to ArrowAssoc[GzipDecompressor] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (gzipDecompressor: ArrowAssoc[GzipDecompressor]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: GzipDecompressor

    Implicit information
    This member is added by an implicit conversion from GzipDecompressor to Ensuring[GzipDecompressor] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (gzipDecompressor: Ensuring[GzipDecompressor]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from DeflateDecompressorBase

Inherited from ByteStringParserStage[ByteString]

Inherited from StatefulStage[ByteString, ByteString]

Inherited from PushPullStage[ByteString, ByteString]

Inherited from AbstractStage[ByteString, ByteString, SyncDirective, SyncDirective, Context[ByteString], LifecycleContext]

Inherited from Stage[ByteString, ByteString]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GzipDecompressor to StringAdd

Inherited by implicit conversion any2stringfmt from GzipDecompressor to StringFormat

Inherited by implicit conversion any2ArrowAssoc from GzipDecompressor to ArrowAssoc[GzipDecompressor]

Inherited by implicit conversion any2Ensuring from GzipDecompressor to Ensuring[GzipDecompressor]

Ungrouped