akka.http.model

HttpEntity

sealed trait HttpEntity extends model.japi.HttpEntity

Models the entity (aka "body" or "content) of an HTTP message.

Source
HttpEntity.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HttpEntity
  2. HttpEntity
  3. AnyRef
  4. 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

Abstract Value Members

  1. abstract def contentType(): ContentType

    The ContentType associated with this entity.

    The ContentType associated with this entity.

    Definition Classes
    HttpEntityHttpEntity
  2. abstract def dataBytes: Source[ByteString]

    A stream of the data of this entity.

  3. abstract def isKnownEmpty(): Boolean

    Determines whether this entity is known to be empty.

    Determines whether this entity is known to be empty.

    Definition Classes
    HttpEntityHttpEntity
  4. abstract def transformDataBytes(transformer: Flow[ByteString, ByteString]): HttpEntity

    Returns a copy of the given entity with the ByteString chunks of this entity transformed by the given transformer.

    Returns a copy of the given entity with the ByteString chunks of this entity transformed by the given transformer. For a Chunked entity, the chunks will be transformed one by one keeping the chunk metadata (but may introduce an extra chunk before the LastChunk if transformer.onTermination returns additional data).

    This method may only throw an exception if the transformer function throws an exception while creating the transformer. Any other errors are reported through the new entity data stream.

  5. abstract def withContentType(contentType: ContentType): HttpEntity

    Creates a copy of this HttpEntity with the contentType overridden with the given one.

Concrete 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 HttpEntity to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (HttpEntity, B)

    Implicit information
    This member is added by an implicit conversion from HttpEntity to ArrowAssoc[HttpEntity] 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (HttpEntity) ⇒ Boolean, msg: ⇒ Any): HttpEntity

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  19. def getDataBytes(): Source[ByteString]

    Java API

    Java API

    Definition Classes
    HttpEntityHttpEntity
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. def isChunked(): Boolean

    Definition Classes
    HttpEntityHttpEntity
  22. def isCloseDelimited(): Boolean

    Definition Classes
    HttpEntityHttpEntity
  23. def isDefault(): Boolean

    Definition Classes
    HttpEntityHttpEntity
  24. def isIndefiniteLength(): Boolean

    Definition Classes
    HttpEntityHttpEntity
  25. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def toStrict(timeout: FiniteDuration)(implicit fm: FlowMaterializer): Future[Strict]

    Collects all possible parts and returns a potentially future Strict entity for easier processing.

    Collects all possible parts and returns a potentially future Strict entity for easier processing. The Future is failed with an TimeoutException if the stream isn't completed after the given timeout.

  31. def toString(): String

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from HttpEntity to ArrowAssoc[HttpEntity] 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 HttpEntity 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:
    (httpEntity: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from HttpEntity 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:
    (httpEntity: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: HttpEntity

    Implicit information
    This member is added by an implicit conversion from HttpEntity to ArrowAssoc[HttpEntity] 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:
    (httpEntity: ArrowAssoc[HttpEntity]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: HttpEntity

    Implicit information
    This member is added by an implicit conversion from HttpEntity to Ensuring[HttpEntity] 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:
    (httpEntity: Ensuring[HttpEntity]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from japi.HttpEntity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from HttpEntity to StringAdd

Inherited by implicit conversion any2stringfmt from HttpEntity to StringFormat

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

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

Ungrouped