Packages

c

play.api.mvc

RawBuffer

case class RawBuffer(memoryThreshold: Long, temporaryFileCreator: TemporaryFileCreator, initialData: ByteString = ByteString.empty) extends Product with Serializable

Handle the request body a raw bytes data.

memoryThreshold

If the content size is bigger than this limit, the content is stored as file.

temporaryFileCreator

the temporary file creator to store the content as file.

initialData

the initial data, ByteString.empty by default.

Source
BodyParsers.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RawBuffer
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RawBuffer(memoryThreshold: Long, temporaryFileCreator: TemporaryFileCreator, initialData: ByteString = ByteString.empty)

    memoryThreshold

    If the content size is bigger than this limit, the content is stored as file.

    temporaryFileCreator

    the temporary file creator to store the content as file.

    initialData

    the initial data, ByteString.empty by default.

Value Members

  1. def asBytes(maxLength: Long = memoryThreshold): Option[ByteString]

    Returns the buffer content as a bytes array.

    Returns the buffer content as a bytes array.

    This operation will cause the internal collection of byte arrays to be copied into a new byte array on each invocation, no caching is done. If the buffer has been written out to a file, it will read the contents of the file.

    maxLength

    The max length allowed to be stored in memory. If this is smaller than memoryThreshold, and the buffer is already in memory then None will still be returned.

    returns

    None if the content is greater than maxLength, otherwise, the data as bytes.

  2. def asFile: File

    Returns the buffer content as File.

  3. val initialData: ByteString
  4. val memoryThreshold: Long
  5. def productElementNames: Iterator[String]
    Definition Classes
    Product
  6. def size: Long

    Buffer size.

  7. val temporaryFileCreator: TemporaryFileCreator
  8. def toString(): String
    Definition Classes
    RawBuffer → AnyRef → Any