Package akka.http.scaladsl.model

Class HttpEntity.HttpEntityScalaDSLSugar

java.lang.Object
scala.AnyVal
akka.http.scaladsl.model.HttpEntity.HttpEntityScalaDSLSugar
Enclosing interface:
HttpEntity
public static final class HttpEntity.HttpEntityScalaDSLSugar extends scala.AnyVal
Adds Scala DSL idiomatic methods to HttpEntity, e.g. versions of methods with an implicit Materializer.

  • Constructor Details

    • HttpEntityScalaDSLSugar

      public HttpEntityScalaDSLSugar(HttpEntity httpEntity)

  • Method Details

    • httpEntity

      public HttpEntity httpEntity()

    • discardBytes

      public HttpMessage.DiscardedEntity discardBytes(akka.stream.Materializer mat)
      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 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.

      Parameters:
      mat - (undocumented)
      Returns:
      (undocumented)