Packages

c

org.apache.pekko.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. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from HttpEntityScalaDSLSugar toany2stringadd[HttpEntityScalaDSLSugar] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HttpEntityScalaDSLSugar, B)
    Implicit
    This member is added by an implicit conversion from HttpEntityScalaDSLSugar toArrowAssoc[HttpEntityScalaDSLSugar] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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 pekko.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.

  8. def ensuring(cond: (HttpEntityScalaDSLSugar) => Boolean, msg: => Any): HttpEntityScalaDSLSugar
    Implicit
    This member is added by an implicit conversion from HttpEntityScalaDSLSugar toEnsuring[HttpEntityScalaDSLSugar] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (HttpEntityScalaDSLSugar) => Boolean): HttpEntityScalaDSLSugar
    Implicit
    This member is added by an implicit conversion from HttpEntityScalaDSLSugar toEnsuring[HttpEntityScalaDSLSugar] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): HttpEntityScalaDSLSugar
    Implicit
    This member is added by an implicit conversion from HttpEntityScalaDSLSugar toEnsuring[HttpEntityScalaDSLSugar] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): HttpEntityScalaDSLSugar
    Implicit
    This member is added by an implicit conversion from HttpEntityScalaDSLSugar toEnsuring[HttpEntityScalaDSLSugar] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  13. val httpEntity: HttpEntity
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def toString(): String
    Definition Classes
    Any

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HttpEntityScalaDSLSugar toStringFormat[HttpEntityScalaDSLSugar] 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): (HttpEntityScalaDSLSugar, B)
    Implicit
    This member is added by an implicit conversion from HttpEntityScalaDSLSugar toArrowAssoc[HttpEntityScalaDSLSugar] 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 AnyVal

Inherited from Any

Inherited by implicit conversion any2stringadd fromHttpEntityScalaDSLSugar to any2stringadd[HttpEntityScalaDSLSugar]

Inherited by implicit conversion StringFormat fromHttpEntityScalaDSLSugar to StringFormat[HttpEntityScalaDSLSugar]

Inherited by implicit conversion Ensuring fromHttpEntityScalaDSLSugar to Ensuring[HttpEntityScalaDSLSugar]

Inherited by implicit conversion ArrowAssoc fromHttpEntityScalaDSLSugar to ArrowAssoc[HttpEntityScalaDSLSugar]

Ungrouped