Packages

c

akka.http.scaladsl.model.HttpEntity

HttpEntityScalaDSLSugar

implicit final class HttpEntityScalaDSLSugar extends AnyVal

Adds Scala DSL idiomatic methods to HttpEntity, e.g. versions of methods with an implicit Materializer.

Source
HttpEntity.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpEntityScalaDSLSugar
  2. AnyVal
  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 HttpEntityScalaDSLSugar(httpEntity: HttpEntity)

Value Members

  1. def discardBytes()(implicit mat: Materializer): HttpMessage.DiscardedEntity

    Discards the entities data bytes by running the dataBytes Source contained in this entity.

    Discards the entities data bytes by running the dataBytes Source contained in this entity.

    Note: It is crucial that entities are either discarded, or consumed by running the underlying akka.stream.scaladsl.Source as otherwise the lack of consuming of the data will trigger back-pressure to the underlying TCP connection (as designed), however possibly leading to an idle-timeout that will close the connection, instead of just having ignored the data.

    Warning: It is not allowed to discard and/or consume the entity.dataBytes more than once as the stream is directly attached to the "live" incoming data source from the underlying TCP connection. Allowing it to be consumable twice would require buffering the incoming data, thus defeating the purpose of its streaming nature. If the dataBytes source is materialized a second time, it will fail with an "stream can cannot be materialized more than once" exception.

    In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.

  2. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  3. val httpEntity: HttpEntity