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
).
- Source
- HttpEntity.scala
- Alphabetic
- By Inheritance
- Chunked
- Serializable
- Product
- Equals
- RequestEntity
- ResponseEntity
- HttpEntity
- Chunked
- RequestEntity
- ResponseEntity
- HttpEntity
- AnyRef
- Any
- by fromJava
- by HttpEntityScalaDSLSugar
- by HttpEntityScalaDSLSugar
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Chunked(contentType: ContentType, chunks: Source[ChunkStreamPart, Any])
Value Members
- val chunks: Source[ChunkStreamPart, Any]
- 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
- Chunked → HttpEntity
- val contentType: ContentType
The
ContentType
associated with this entity.The
ContentType
associated with this entity.- Definition Classes
- Chunked → HttpEntity
- def dataBytes: Source[ByteString, Any]
A stream of the data of this entity.
A stream of the data of this entity.
- Definition Classes
- Chunked → HttpEntity
- def discardBytes(system: ClassicActorSystemProvider): HttpMessage.DiscardedEntity
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def discardBytes(mat: Materializer): HttpMessage.DiscardedEntity
Discards the entities data bytes by running the
dataBytes
Source contained in thisentity
.Discards the entities data bytes by running the
dataBytes
Source contained in thisentity
.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
- HttpEntity → HttpEntity
- def getChunks(): Source[javadsl.model.HttpEntity.ChunkStreamPart, AnyRef]
Java API
Java API
- Definition Classes
- Chunked → Chunked
- def getContentLengthOption(): OptionalLong
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def getContentType(): javadsl.model.ContentType
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def getDataBytes(): Source[ByteString, AnyRef]
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def isChunked(): Boolean
Returns if this entity is a subtype of HttpEntityChunked.
Returns if this entity is a subtype of HttpEntityChunked.
- Definition Classes
- Chunked → HttpEntity → HttpEntity
- def isCloseDelimited(): Boolean
Returns if this entity is a subtype of HttpEntityCloseDelimited.
Returns if this entity is a subtype of HttpEntityCloseDelimited.
- Definition Classes
- HttpEntity → HttpEntity
- def isDefault(): Boolean
Returns if this entity is a subtype of HttpEntityDefault.
Returns if this entity is a subtype of HttpEntityDefault.
- Definition Classes
- HttpEntity → HttpEntity
- def isIndefiniteLength(): Boolean
Returns if this entity is a subtype of HttpEntityIndefiniteLength.
Returns if this entity is a subtype of HttpEntityIndefiniteLength.
- Definition Classes
- HttpEntity → HttpEntity
- def isKnownEmpty(): Boolean
Determines whether this entity is known to be empty.
Determines whether this entity is known to be empty.
- Definition Classes
- Chunked → HttpEntity → HttpEntity
- def isStrict(): Boolean
Returns if this entity is a subtype of HttpEntityStrict.
Returns if this entity is a subtype of HttpEntityStrict.
- Definition Classes
- HttpEntity → HttpEntity
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productPrefix: String
- Definition Classes
- Chunked → Product
- def toStrict(timeoutMillis: Long, maxBytes: Long, system: ClassicActorSystemProvider): CompletionStage[javadsl.model.HttpEntity.Strict]
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeoutMillis: Long, system: ClassicActorSystemProvider): CompletionStage[javadsl.model.HttpEntity.Strict]
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeoutMillis: Long, maxBytes: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeout: FiniteDuration, maxBytes: Long)(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, or with a EntityStreamException when the end of the entity is not reached within the maximum number of bytes.
- Definition Classes
- HttpEntity
- 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, or with a EntityStreamException when the end of the entity is not reached within the maximum number of bytes as configured in
akka.http.parsing.max-to-strict-bytes
. Not that this method does not support different defaults for client- and server use: if you want that, use thetoStrict
method and pass in an explicit maximum number of bytes.- Definition Classes
- HttpEntity
- def toString(): String
- Definition Classes
- Chunked → AnyRef → Any
- def transformDataBytes(transformer: Flow[ByteString, ByteString, Any]): Chunked
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 theLastChunk
iftransformer.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
- Chunked → RequestEntity → ResponseEntity → HttpEntity
- 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
.Transforms this' entities data bytes with a transformer that will produce exactly the number of bytes given as
newContentLength
.- Definition Classes
- HttpEntity
- def withContentType(contentType: ContentType): Chunked
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
- Chunked → RequestEntity → ResponseEntity → HttpEntity
- def withContentType(contentType: javadsl.model.ContentType): HttpEntity
Java API
Java API
- Definition Classes
- HttpEntity → HttpEntity
- def withSizeLimit(maxBytes: Long): Chunked
- Definition Classes
- Chunked → RequestEntity → ResponseEntity → HttpEntity → HttpEntity
- def withoutSizeLimit(): Chunked
See HttpEntity#withoutSizeLimit.
- Definition Classes
- Chunked → RequestEntity → ResponseEntity → HttpEntity → HttpEntity
Shadowed Implicit Value Members
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).contentLengthOption
- Definition Classes
- HttpEntity
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).contentType
- Definition Classes
- HttpEntity
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).dataBytes
- Definition Classes
- HttpEntity
- def discardBytes(system: ClassicActorSystemProvider): HttpMessage.DiscardedEntity
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).discardBytes(system)
- Definition Classes
- HttpEntity → HttpEntity
- def discardBytes(mat: Materializer): HttpMessage.DiscardedEntity
Discards the entities data bytes by running the
dataBytes
Source contained in thisentity
.Discards the entities data bytes by running the
dataBytes
Source contained in thisentity
.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 Chunked toResponseEntity 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:(chunked: ResponseEntity).discardBytes(mat)
- Definition Classes
- HttpEntity → HttpEntity
- def discardBytes()(implicit mat: Materializer): HttpMessage.DiscardedEntity
Discards the entities data bytes by running the
dataBytes
Source contained in thisentity
.Discards the entities data bytes by running the
dataBytes
Source contained in thisentity
.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 Chunked toHttpEntityScalaDSLSugar 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:(chunked: HttpEntityScalaDSLSugar).discardBytes()(mat)
- Definition Classes
- HttpEntityScalaDSLSugar
- def discardBytes()(implicit mat: Materializer): HttpMessage.DiscardedEntity
Discards the entities data bytes by running the
dataBytes
Source contained in thisentity
.Discards the entities data bytes by running the
dataBytes
Source contained in thisentity
.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 Chunked toHttpEntityScalaDSLSugar 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:(chunked: HttpEntityScalaDSLSugar).discardBytes()(mat)
- Definition Classes
- HttpEntityScalaDSLSugar
- def getContentLengthOption(): OptionalLong
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).getContentLengthOption()
- Definition Classes
- HttpEntity → HttpEntity
- def getContentType(): javadsl.model.ContentType
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).getContentType()
- Definition Classes
- HttpEntity → HttpEntity
- def getDataBytes(): Source[ByteString, AnyRef]
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).getDataBytes()
- Definition Classes
- HttpEntity → HttpEntity
- val httpEntity: HttpEntity
- Implicit
- This member is added by an implicit conversion from Chunked toHttpEntityScalaDSLSugar performed by method HttpEntityScalaDSLSugar in akka.http.scaladsl.model.HttpEntity.
- 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:(chunked: HttpEntityScalaDSLSugar).httpEntity
- Definition Classes
- HttpEntityScalaDSLSugar
- val httpEntity: HttpEntity
- Implicit
- This member is added by an implicit conversion from Chunked toHttpEntityScalaDSLSugar performed by method HttpEntityScalaDSLSugar in akka.http.scaladsl.model.HttpEntity.
- 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:(chunked: HttpEntityScalaDSLSugar).httpEntity
- Definition Classes
- HttpEntityScalaDSLSugar
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).isChunked()
- Definition Classes
- HttpEntity → HttpEntity
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).isCloseDelimited()
- Definition Classes
- HttpEntity → HttpEntity
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).isDefault()
- Definition Classes
- HttpEntity → HttpEntity
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).isIndefiniteLength()
- Definition Classes
- HttpEntity → HttpEntity
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).isKnownEmpty()
- Definition Classes
- HttpEntity → HttpEntity
- def isStrict(): Boolean
Returns if this entity is a subtype of HttpEntityStrict.
Returns if this entity is a subtype of HttpEntityStrict.
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).isStrict()
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeoutMillis: Long, maxBytes: Long, system: ClassicActorSystemProvider): CompletionStage[javadsl.model.HttpEntity.Strict]
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).toStrict(timeoutMillis, maxBytes, system)
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeoutMillis: Long, system: ClassicActorSystemProvider): CompletionStage[javadsl.model.HttpEntity.Strict]
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).toStrict(timeoutMillis, system)
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeoutMillis: Long, maxBytes: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).toStrict(timeoutMillis, maxBytes, materializer)
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).toStrict(timeoutMillis, materializer)
- Definition Classes
- HttpEntity → HttpEntity
- def toStrict(timeout: FiniteDuration, maxBytes: Long)(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, or with a EntityStreamException when the end of the entity is not reached within the maximum number of bytes.
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).toStrict(timeout, maxBytes)(fm)
- Definition Classes
- HttpEntity
- 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, or with a EntityStreamException when the end of the entity is not reached within the maximum number of bytes as configured in
akka.http.parsing.max-to-strict-bytes
. Not that this method does not support different defaults for client- and server use: if you want that, use thetoStrict
method and pass in an explicit maximum number of bytes.- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).toStrict(timeout)(fm)
- Definition Classes
- HttpEntity
- 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
.Transforms this' entities data bytes with a transformer that will produce exactly the number of bytes given as
newContentLength
.- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).transformDataBytes(newContentLength, transformer)
- Definition Classes
- HttpEntity
- 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 theLastChunk
iftransformer.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 Chunked toResponseEntity 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:(chunked: ResponseEntity).transformDataBytes(transformer)
- Definition Classes
- ResponseEntity → HttpEntity
- def withContentType(contentType: javadsl.model.ContentType): HttpEntity
Java API
Java API
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).withContentType(contentType)
- Definition Classes
- HttpEntity → HttpEntity
- 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 Chunked toResponseEntity 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:(chunked: ResponseEntity).withContentType(contentType)
- Definition Classes
- ResponseEntity → HttpEntity
- def withSizeLimit(maxBytes: Long): ResponseEntity
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).withSizeLimit(maxBytes)
- Definition Classes
- ResponseEntity → HttpEntity → HttpEntity
- def withoutSizeLimit(): ResponseEntity
See HttpEntity#withoutSizeLimit
- Implicit
- This member is added by an implicit conversion from Chunked toResponseEntity 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:(chunked: ResponseEntity).withoutSizeLimit()
- Definition Classes
- ResponseEntity → HttpEntity → HttpEntity