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
- Alphabetic
- By Inheritance
- HttpEntityScalaDSLSugar
- AnyVal
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new HttpEntityScalaDSLSugar(httpEntity: HttpEntity)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##: Int
- Definition Classes
- Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def discardBytes()(implicit mat: Materializer): HttpMessage.DiscardedEntity
Discards the entities data bytes by running the
dataBytesSource contained in thisentity.Discards the entities data bytes by running the
dataBytesSource contained in thisentity.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.dataBytesmore 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.
- 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
- 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
- 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
- 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
- def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- val httpEntity: HttpEntity
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def toString(): String
- Definition Classes
- Any
Deprecated Value Members
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.