HttpEntity

Type Members

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

An intermediate entity chunk guaranteed to carry non-empty data.
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.
final case class Chunked(contentType: ContentType, chunks: Source[HttpEntity.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).
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.
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.
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.
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.
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.
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.
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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object Chunk extends Serializable
object ChunkStreamPart
object Chunked extends Serializable
val Empty: Strict
object LastChunk extends LastChunk
def apply(contentType: ContentType, data: Source[ByteString, Any]): Chunked
def apply(contentType: ContentType, contentLength: Long, data: Source[ByteString, Any]): UniversalEntity
def apply(contentType: ContentType, data: ByteString): Strict
def apply(contentType: ContentType, bytes: Array[Byte]): Strict
def apply(contentType: NonBinary, string: String): Strict
implicit def apply(data: ByteString): Strict
implicit def apply(bytes: Array[Byte]): Strict
implicit def apply(string: String): Strict
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def empty(contentType: ContentType): Strict
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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 akka.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 akka.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.
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 akka.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 akka.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.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def limitableByteSource[Mat](source: Source[ByteString, Mat]): Source[ByteString, Mat]

Turns the given source into one that respects the withSizeLimit calls when used as a parameter to entity constructors.
def limitableChunkSource[Mat](source: Source[ChunkStreamPart, Mat]): Source[ChunkStreamPart, Mat]

Turns the given source into one that respects the withSizeLimit calls when used as a parameter to entity constructors.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: trait HttpEntity | package model

object HttpEntity

Type Members

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

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

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

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

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

final class DiscardedEntity extends javadsl.model.HttpMessage.DiscardedEntity

implicit final class HttpEntityScalaDSLSugar extends AnyVal

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

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

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Chunk extends Serializable

object ChunkStreamPart

object Chunked extends Serializable

val Empty: Strict

object LastChunk extends LastChunk

def apply(contentType: ContentType, data: Source[ByteString, Any]): Chunked

def apply(contentType: ContentType, contentLength: Long, data: Source[ByteString, Any]): UniversalEntity

def apply(contentType: ContentType, data: ByteString): Strict

def apply(contentType: ContentType, bytes: Array[Byte]): Strict

def apply(contentType: NonBinary, string: String): Strict

implicit def apply(data: ByteString): Strict

implicit def apply(bytes: Array[Byte]): Strict

implicit def apply(string: String): Strict

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def empty(contentType: ContentType): Strict

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fromFile(contentType: ContentType, file: File, chunkSize: Int = 1): UniversalEntity

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

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped