akka.http.scaladsl.model

UniversalEntity

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

Source
HttpEntity.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
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 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 contentLength: Long

  2. abstract def contentType(): ContentType

    The ContentType associated with this entity.

    The ContentType associated with this entity.

    Definition Classes
    HttpEntityHttpEntity
  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

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

    Implicit information
    This member is added by an implicit conversion from UniversalEntity to ArrowAssoc[UniversalEntity] 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 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
  11. def ensuring(cond: (UniversalEntity) ⇒ Boolean, msg: ⇒ Any): UniversalEntity

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  20. def getContentLengthOption(): Option[Long]

    Java API

    Java API

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

    Java API

    Java API

    Definition Classes
    HttpEntityHttpEntity
  22. def hashCode(): Int

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

    Definition Classes
    HttpEntityHttpEntity
  24. def isCloseDelimited(): Boolean

    Definition Classes
    HttpEntityHttpEntity
  25. def isDefault(): Boolean

    Definition Classes
    HttpEntityHttpEntity
  26. def isIndefiniteLength(): Boolean

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

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

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

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

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

    Definition Classes
    AnyRef
  32. def toStrict(timeoutMillis: Long, materializer: Materializer): Future[HttpEntityStrict]

    Java API

    Java API

    Definition Classes
    HttpEntityHttpEntity
  33. 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
  34. def toString(): String

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

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

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

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

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

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

Deprecated Value Members

  1. def x: UniversalEntity

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: UniversalEntity

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

    (Since version 2.10.0) Use resultOfEnsuring instead

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 any2stringadd from UniversalEntity to StringAdd

Inherited by implicit conversion any2stringfmt from UniversalEntity to StringFormat

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

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

Ungrouped