Class

play.api.mvc

RawBuffer

Related Doc: package mvc

Permalink

case class RawBuffer(memoryThreshold: Int, 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, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RawBuffer
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def asBytes(maxLength: Long = memoryThreshold): Option[ByteString]

    Permalink

    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.

  5. def asFile: File

    Permalink

    Returns the buffer content as File.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. val initialData: ByteString

    Permalink

    the initial data, ByteString.empty by default.

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. val memoryThreshold: Int

    Permalink

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

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. def size: Long

    Permalink

    Buffer size.

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

    Permalink
    Definition Classes
    AnyRef
  19. val temporaryFileCreator: TemporaryFileCreator

    Permalink

    the temporary file creator to store the content as file.

  20. def toString(): String

    Permalink
    Definition Classes
    RawBuffer → AnyRef → Any
  21. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped