object HttpEntity

Source
HttpEntity.scala
Linear Supertypes
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpEntity
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Chunk(data: ByteString, extension: String = "") extends ChunkStreamPart with Product with Serializable

    An intermediate entity chunk guaranteed to carry non-empty data.

  2. sealed abstract class ChunkStreamPart extends javadsl.model.HttpEntity.ChunkStreamPart

    An element of the HttpEntity data stream.

    An element of the HttpEntity data stream. Can be either a Chunk or a LastChunk.

  3. final case class Chunked(contentType: ContentType, chunks: Source[ChunkStreamPart, Any]) extends javadsl.model.HttpEntity.Chunked with MessageEntity with Product with Serializable

    The model for the entity of a chunked HTTP message (with Transfer-Encoding: chunked).

  4. final case class CloseDelimited(contentType: ContentType, data: Source[ByteString, Any]) extends javadsl.model.HttpEntity.CloseDelimited with ResponseEntity with WithoutKnownLength with Product with Serializable

    The model for the entity of an HTTP response that is terminated by the server closing the connection.

    The model for the entity of an HTTP response that is terminated by the server closing the connection. The content-length of such responses is unknown at the time the response headers have been received. Note that this type of HttpEntity can only be used for HttpResponses.

  5. final case class Default(contentType: ContentType, contentLength: Long, data: Source[ByteString, Any]) extends javadsl.model.HttpEntity.Default with UniversalEntity with Product with Serializable

    The model for the entity of a "regular" unchunked HTTP message with a known non-zero length.

  6. final class DiscardedEntity extends javadsl.model.HttpMessage.DiscardedEntity

    Represents the currently being-drained HTTP Entity which triggers completion of the contained Future once the entity has been drained for the given HttpMessage completely.

  7. implicit final class HttpEntityScalaDSLSugar extends AnyVal

    Adds Scala DSL idiomatic methods to HttpEntity, e.g.

    Adds Scala DSL idiomatic methods to HttpEntity, e.g. versions of methods with an implicit Materializer.

  8. final case class IndefiniteLength(contentType: ContentType, data: Source[ByteString, Any]) extends javadsl.model.HttpEntity.IndefiniteLength with BodyPartEntity with WithoutKnownLength with Product with Serializable

    The model for the entity of a BodyPart with an indefinite length.

    The model for the entity of a BodyPart with an indefinite length. Note that this type of HttpEntity can only be used for BodyParts.

  9. case class LastChunk(extension: String = "", trailer: Seq[HttpHeader] = Nil) extends ChunkStreamPart with Product with Serializable

    The final chunk of a chunk stream.

    The final chunk of a chunk stream. If you don't need extensions or trailer headers you can save an allocation by directly using the LastChunk companion object.

  10. final case class Strict(contentType: ContentType, data: ByteString) extends javadsl.model.HttpEntity.Strict with UniversalEntity with Product with Serializable

    The model for the entity of a "regular" unchunked HTTP message with known, fixed data.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val Empty: Strict
  5. def apply(contentType: ContentType, data: Source[ByteString, Any]): Chunked
  6. def apply(contentType: ContentType, contentLength: Long, data: Source[ByteString, Any]): UniversalEntity
  7. def apply(contentType: ContentType, data: ByteString): Strict
  8. def apply(contentType: ContentType, bytes: Array[Byte]): Strict
  9. def apply(contentType: WithFixedCharset, string: String): Strict
  10. def apply(contentType: NonBinary, string: String): Strict
  11. implicit def apply(data: ByteString): Strict
  12. implicit def apply(bytes: Array[Byte]): Strict
  13. implicit def apply(string: String): Strict
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. def empty(contentType: ContentType): Strict
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. def fromFile(contentType: ContentType, file: File, chunkSize: Int = -1): UniversalEntity

    Returns either the empty entity, if the given file is empty, or a HttpEntity.Default entity consisting of a stream of pekko.util.ByteString instances each containing chunkSize bytes (except for the final ByteString, which simply contains the remaining bytes).

    Returns either the empty entity, if the given file is empty, or a HttpEntity.Default entity consisting of a stream of pekko.util.ByteString instances each containing chunkSize bytes (except for the final ByteString, which simply contains the remaining bytes).

    If the given chunkSize is -1 the default chunk size is used.

  21. def fromPath(contentType: ContentType, file: Path, chunkSize: Int = -1): UniversalEntity

    Returns either the empty entity, if the given file is empty, or a HttpEntity.Default entity consisting of a stream of pekko.util.ByteString instances each containing chunkSize bytes (except for the final ByteString, which simply contains the remaining bytes).

    Returns either the empty entity, if the given file is empty, or a HttpEntity.Default entity consisting of a stream of pekko.util.ByteString instances each containing chunkSize bytes (except for the final ByteString, which simply contains the remaining bytes).

    If the given chunkSize is -1 the default chunk size is used.

  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. object Chunk extends Serializable
  34. object ChunkStreamPart
  35. object Chunked extends Serializable
  36. object LastChunk extends LastChunk

Deprecated Value Members

  1. def limitableByteSource[Mat](source: Source[ByteString, Mat]): Source[ByteString, Mat]

    Deprecated: no-op, not explicitly needed any more.

    Deprecated: no-op, not explicitly needed any more.

    Annotations
    @deprecated
    Deprecated

    (Since version Akka HTTP 10.1.5) Not needed explicitly any more.

  2. def limitableChunkSource[Mat](source: Source[ChunkStreamPart, Mat]): Source[ChunkStreamPart, Mat]

    Deprecated: no-op, not explicitly needed any more.

    Deprecated: no-op, not explicitly needed any more.

    Annotations
    @deprecated
    Deprecated

    (Since version Akka HTTP 10.1.5) Not needed explicitly any more.

Inherited from AnyRef

Inherited from Any

Ungrouped