t

akka.http.scaladsl.model

UniversalEntity

sealed trait UniversalEntity extends javadsl.model.UniversalEntity with MessageEntity with BodyPartEntity

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UniversalEntity
  2. BodyPartEntity
  3. RequestEntity
  4. ResponseEntity
  5. HttpEntity
  6. UniversalEntity
  7. BodyPartEntity
  8. RequestEntity
  9. ResponseEntity
  10. HttpEntity
  11. AnyRef
  12. Any
Implicitly
  1. by HttpEntityScalaDSLSugar
  2. by fromJava
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def contentLength: Long
  2. abstract def contentType: ContentType

    The ContentType associated with this entity.

    The ContentType associated with this entity.

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

    A stream of the data of this entity.

    A stream of the data of this entity.

    Definition Classes
    HttpEntity
  4. 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
  5. abstract def transformDataBytes(newContentLength: Long, transformer: Flow[ByteString, ByteString, Any]): UniversalEntity

    Transforms this' entities data bytes with a transformer that will produce exactly the number of bytes given as newContentLength.

  6. abstract def transformDataBytes(transformer: Flow[ByteString, ByteString, Any]): RequestEntity

    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.

    Definition Classes
    RequestEntityResponseEntityHttpEntity
  7. abstract def withContentType(contentType: ContentType): UniversalEntity

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

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

    Definition Classes
    UniversalEntityBodyPartEntityRequestEntityResponseEntityHttpEntity
  8. abstract def withSizeLimit(maxBytes: Long): UniversalEntity

    See HttpEntity#withSizeLimit.

  9. abstract def withoutSizeLimit(): UniversalEntity

    See HttpEntity#withoutSizeLimit

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from UniversalEntity to any2stringadd[UniversalEntity] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (UniversalEntity, B)
    Implicit
    This member is added by an implicit conversion from UniversalEntity to ArrowAssoc[UniversalEntity] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def contentLengthOption: Option[Long]

    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.

    Definition Classes
    UniversalEntityHttpEntity
  9. def discardBytes(mat: Materializer): 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 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.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.

    When called on Strict entities or sources whose values can be buffered in memory, the above warnings can be ignored. Repeated materialization is not necessary in this case, avoiding the mentioned exceptions due to the data being held in memory.

    In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.

    Definition Classes
    HttpEntityHttpEntity
  10. def ensuring(cond: (UniversalEntity) ⇒ Boolean, msg: ⇒ Any): UniversalEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to Ensuring[UniversalEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (UniversalEntity) ⇒ Boolean): UniversalEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to Ensuring[UniversalEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): UniversalEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to Ensuring[UniversalEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): UniversalEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to Ensuring[UniversalEntity] performed by method Ensuring 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
    This member is added by an implicit conversion from UniversalEntity to StringFormat[UniversalEntity] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getContentLengthOption(): OptionalLong

    Java API

    Java API

    Definition Classes
    HttpEntityHttpEntity
  20. def getContentType(): javadsl.model.ContentType

    Java API

    Java API

    Definition Classes
    HttpEntityHttpEntity
  21. def getDataBytes(): Source[ByteString, AnyRef]

    Java API

    Java API

    Definition Classes
    HttpEntityHttpEntity
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. val httpEntity: HttpEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to HttpEntityScalaDSLSugar performed by method HttpEntityScalaDSLSugar in akka.http.scaladsl.model.HttpEntity.
    Definition Classes
    HttpEntityScalaDSLSugar
  24. def isChunked(): Boolean

    Returns if this entity is a subtype of HttpEntityChunked.

    Returns if this entity is a subtype of HttpEntityChunked.

    Definition Classes
    HttpEntityHttpEntity
  25. def isCloseDelimited(): Boolean

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Definition Classes
    HttpEntityHttpEntity
  26. def isDefault(): Boolean

    Returns if this entity is a subtype of HttpEntityDefault.

    Returns if this entity is a subtype of HttpEntityDefault.

    Definition Classes
    HttpEntityHttpEntity
  27. def isIndefiniteLength(): Boolean

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Definition Classes
    HttpEntityHttpEntity
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]

    Java API

    Java API

    Definition Classes
    HttpEntityHttpEntity
  34. def toStrict(timeout: FiniteDuration)(implicit fm: Materializer): 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.

    Definition Classes
    HttpEntity
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  39. def withContentType(contentType: javadsl.model.ContentType): HttpEntity

    Java API

    Java API

    Definition Classes
    HttpEntityHttpEntity
  40. def [B](y: B): (UniversalEntity, B)
    Implicit
    This member is added by an implicit conversion from UniversalEntity to ArrowAssoc[UniversalEntity] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def contentLengthOption: Option[Long]

    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.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).contentLengthOption
    Definition Classes
    HttpEntity
  2. def contentType: ContentType

    The ContentType associated with this entity.

    The ContentType associated with this entity.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).contentType
    Definition Classes
    HttpEntity
  3. def dataBytes: Source[ByteString, Any]

    A stream of the data of this entity.

    A stream of the data of this entity.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).dataBytes
    Definition Classes
    HttpEntity
  4. def discardBytes()(implicit mat: Materializer): 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 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.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.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to HttpEntityScalaDSLSugar performed by method HttpEntityScalaDSLSugar in akka.http.scaladsl.model.HttpEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: HttpEntityScalaDSLSugar).discardBytes()(mat)
    Definition Classes
    HttpEntityScalaDSLSugar
  5. def discardBytes(mat: Materializer): 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 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.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.

    When called on Strict entities or sources whose values can be buffered in memory, the above warnings can be ignored. Repeated materialization is not necessary in this case, avoiding the mentioned exceptions due to the data being held in memory.

    In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).discardBytes(mat)
    Definition Classes
    HttpEntityHttpEntity
  6. def getContentLengthOption(): OptionalLong

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).getContentLengthOption()
    Definition Classes
    HttpEntityHttpEntity
  7. def getContentType(): javadsl.model.ContentType

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).getContentType()
    Definition Classes
    HttpEntityHttpEntity
  8. def getDataBytes(): Source[ByteString, AnyRef]

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).getDataBytes()
    Definition Classes
    HttpEntityHttpEntity
  9. def isChunked(): Boolean

    Returns if this entity is a subtype of HttpEntityChunked.

    Returns if this entity is a subtype of HttpEntityChunked.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).isChunked()
    Definition Classes
    HttpEntityHttpEntity
  10. def isCloseDelimited(): Boolean

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).isCloseDelimited()
    Definition Classes
    HttpEntityHttpEntity
  11. def isDefault(): Boolean

    Returns if this entity is a subtype of HttpEntityDefault.

    Returns if this entity is a subtype of HttpEntityDefault.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).isDefault()
    Definition Classes
    HttpEntityHttpEntity
  12. def isIndefiniteLength(): Boolean

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).isIndefiniteLength()
    Definition Classes
    HttpEntityHttpEntity
  13. def isKnownEmpty(): Boolean

    Determines whether this entity is known to be empty.

    Determines whether this entity is known to be empty.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).isKnownEmpty()
    Definition Classes
    HttpEntityHttpEntity
  14. def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).toStrict(timeoutMillis, materializer)
    Definition Classes
    HttpEntityHttpEntity
  15. def toStrict(timeout: FiniteDuration)(implicit fm: Materializer): 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.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).toStrict(timeout)(fm)
    Definition Classes
    HttpEntity
  16. def transformDataBytes(transformer: Flow[ByteString, ByteString, Any]): ResponseEntity

    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.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).transformDataBytes(transformer)
    Definition Classes
    ResponseEntityHttpEntity
  17. def withContentType(contentType: javadsl.model.ContentType): HttpEntity

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).withContentType(contentType)
    Definition Classes
    HttpEntityHttpEntity
  18. def withContentType(contentType: ContentType): ResponseEntity

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

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

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).withContentType(contentType)
    Definition Classes
    ResponseEntityHttpEntity
  19. def withSizeLimit(maxBytes: Long): ResponseEntity

    See HttpEntity#withSizeLimit.

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).withSizeLimit(maxBytes)
    Definition Classes
    ResponseEntityHttpEntityHttpEntity
  20. def withoutSizeLimit(): ResponseEntity

    See HttpEntity#withoutSizeLimit

    Implicit
    This member is added by an implicit conversion from UniversalEntity to ResponseEntity performed by method fromJava in akka.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (universalEntity: ResponseEntity).withoutSizeLimit()
    Definition Classes
    ResponseEntityHttpEntityHttpEntity

Inherited from BodyPartEntity

Inherited from RequestEntity

Inherited from ResponseEntity

Inherited from HttpEntity

Inherited from javadsl.model.HttpEntity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion HttpEntityScalaDSLSugar from UniversalEntity to HttpEntityScalaDSLSugar

Inherited by implicit conversion fromJava from UniversalEntity to ResponseEntity

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

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

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

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

Ungrouped