Trait/Object

akka.http.scaladsl.model

HttpEntity

Related Docs: object HttpEntity | package model

Permalink

sealed trait HttpEntity extends javadsl.model.HttpEntity

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

Source
HttpEntity.scala
Linear Supertypes
javadsl.model.HttpEntity, AnyRef, Any
Known Subclasses
BodyPartEntity, Chunked, CloseDelimited, Default, IndefiniteLength, RequestEntity, ResponseEntity, Strict, UniversalEntity
Type Hierarchy
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HttpEntity
  2. HttpEntity
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. type ChunkStreamPart = javadsl.model.HttpEntity.ChunkStreamPart

    Permalink
    Attributes
    protected
    Definition Classes
    HttpEntity

  2. type Chunked = javadsl.model.HttpEntity.Chunked

    Permalink
    Attributes
    protected
    Definition Classes
    HttpEntity

  3. type CloseDelimited = javadsl.model.HttpEntity.CloseDelimited

    Permalink
    Attributes
    protected
    Definition Classes
    HttpEntity

  4. type Default = javadsl.model.HttpEntity.Default

    Permalink
    Attributes
    protected
    Definition Classes
    HttpEntity

  5. type IndefiniteLength = javadsl.model.HttpEntity.IndefiniteLength

    Permalink
    Attributes
    protected
    Definition Classes
    HttpEntity

  6. type Strict = javadsl.model.HttpEntity.Strict

    Permalink
    Attributes
    protected
    Definition Classes
    HttpEntity

Abstract Value Members

  1. abstract def contentLengthOption: Option[Long]

    Permalink

    Some(content length) if a length is defined for this entity, None otherwise.

    Some(content length) if a length is defined for this entity, None otherwise. A length is only defined for Strict and Default entity types.

    In many cases it's dangerous to rely on the (non-)existence of a content-length. HTTP intermediaries like (transparent) proxies are allowed to change the transfer-encoding which can result in the entity being delivered as another type as expected.

  2. abstract def contentType: ContentType

    Permalink

    The ContentType associated with this entity.

  3. abstract def dataBytes: Source[ByteString, Any]

    Permalink

    A stream of the data of this entity.

  4. abstract def isKnownEmpty(): Boolean

    Permalink

    Determines whether this entity is known to be empty.

    Determines whether this entity is known to be empty.

    Definition Classes
    HttpEntity → HttpEntity

  5. abstract def transformDataBytes(transformer: Flow[ByteString, ByteString, Any]): HttpEntity

    Permalink

    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.

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

    Permalink

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

  7. abstract def withSizeLimit(maxBytes: Long): javadsl.model.HttpEntity

    Permalink
    Definition Classes
    HttpEntity

  8. abstract def withoutSizeLimit(): javadsl.model.HttpEntity

    Permalink
    Definition Classes
    HttpEntity

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpEntity to any2stringadd[HttpEntity] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (HttpEntity, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpEntity to ArrowAssoc[HttpEntity] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (HttpEntity) ⇒ Boolean, msg: ⇒ Any): HttpEntity

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpEntity to Ensuring[HttpEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (HttpEntity) ⇒ Boolean): HttpEntity

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpEntity to Ensuring[HttpEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): HttpEntity

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpEntity to Ensuring[HttpEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): HttpEntity

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpEntity to Ensuring[HttpEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpEntity to StringFormat[HttpEntity] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def getContentLengthOption(): OptionalLong

    Permalink

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity

  18. def getContentType(): javadsl.model.ContentType

    Permalink

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity

  19. def getDataBytes(): Source[ByteString, AnyRef]

    Permalink

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  21. def isChunked(): Boolean

    Permalink
    Definition Classes
    HttpEntity → HttpEntity

  22. def isCloseDelimited(): Boolean

    Permalink
    Definition Classes
    HttpEntity → HttpEntity

  23. def isDefault(): Boolean

    Permalink
    Definition Classes
    HttpEntity → HttpEntity

  24. def isIndefiniteLength(): Boolean

    Permalink
    Definition Classes
    HttpEntity → HttpEntity

  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  30. def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]

    Permalink

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity

  31. def toStrict(timeout: FiniteDuration)(implicit fm: Materializer): Future[HttpEntity.Strict]

    Permalink

    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.

  32. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. def →[B](y: B): (HttpEntity, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpEntity to ArrowAssoc[HttpEntity] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from javadsl.model.HttpEntity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from HttpEntity to any2stringadd[HttpEntity]

Inherited by implicit conversion StringFormat from HttpEntity to StringFormat[HttpEntity]

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

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

Ungrouped