BodyReader

org.http4s.blaze.http.BodyReader
See theBodyReader companion object
trait BodyReader

Representation of a HTTP message body

Attributes

Note

The release of resources must be idempotent, meaning that discard() may be called after complete consumption of the body and it may also be called numerous times.

Companion
object
Source
BodyReader.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Proxy

Members list

Value members

Abstract methods

Get a Future which may contain message body data.

Get a Future which may contain message body data.

If no data remains, the ByteBuffer will be empty as defined by ByteBuffer.hasRemaining()

Attributes

Source
BodyReader.scala
def discard(): Unit

Throw away this BodyReader

Throw away this BodyReader

Attributes

Source
BodyReader.scala

Examine whether the BodyReader may yield additional data.

Examine whether the BodyReader may yield additional data.

This may be a result of being discarded, failure, or deletion of the data stream.

Because BodyReader is async it is not, in general, possible to definitively determine if more data remains in the stream. Therefore, the contract of this method is that a return value of true guarantees that no more data can be obtained from this BodyReader, but a return value of false does not guarantee more data.

Attributes

Source
BodyReader.scala

Concrete methods

Accumulate any remaining data.

Accumulate any remaining data.

The remainder of the message body will be accumulated into a single buffer. If no data remains, the ByteBuffer will be empty as defined by ByteBuffer.hasRemaining()

Value parameters

max

maximum bytes to accumulate before resulting in a failed future with the exception BodyReader.BodyReaderOverflowException.

Attributes

Source
BodyReader.scala