Packages

o

play.core.parsers

Multipart

object Multipart

Utilities for handling multipart bodies

Source
Multipart.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Multipart
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class FileInfo(partName: String, fileName: String, contentType: Option[String], dispositionType: String = "form-data") extends Product with Serializable
  2. type FilePartHandler[A] = (FileInfo) => Accumulator[ByteString, FilePart[A]]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  9. def handleFilePartAsTemporaryFile(temporaryFileCreator: TemporaryFileCreator): FilePartHandler[TemporaryFile]
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def multipartParser[A](maxMemoryBufferSize: Long, allowEmptyFiles: Boolean, filePartHandler: FilePartHandler[A], errorHandler: HttpErrorHandler)(implicit mat: Materializer): BodyParser[MultipartFormData[A]]

    Parses the request body into a Multipart body.

    Parses the request body into a Multipart body.

    maxMemoryBufferSize

    The maximum amount of data to parse into memory.

    allowEmptyFiles

    If empty file uploads are allowed (no matter if filename or file is empty)

    filePartHandler

    The accumulator to handle the file parts.

    errorHandler

    The error handler to call when an error occurs.

  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def partParser[A](maxMemoryBufferSize: Long, allowEmptyFiles: Boolean, errorHandler: HttpErrorHandler)(partHandler: Accumulator[Part[Source[ByteString, _]], Either[Result, A]])(implicit mat: Materializer): BodyParser[A]

    Parses the stream into a stream of play.api.mvc.MultipartFormData.Part to be handled by partHandler.

    Parses the stream into a stream of play.api.mvc.MultipartFormData.Part to be handled by partHandler.

    maxMemoryBufferSize

    The maximum amount of data to parse into memory.

    allowEmptyFiles

    If file uploads are allowed to contain no data in the body

    errorHandler

    The error handler to call when an error occurs.

    partHandler

    The accumulator to handle the parts.

  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def multipartParser[A](maxMemoryBufferSize: Long, filePartHandler: FilePartHandler[A], errorHandler: HttpErrorHandler)(implicit mat: Materializer): BodyParser[MultipartFormData[A]]

    Parses the request body into a Multipart body.

    Parses the request body into a Multipart body.

    maxMemoryBufferSize

    The maximum amount of data to parse into memory.

    filePartHandler

    The accumulator to handle the file parts.

    errorHandler

    The error handler to call when an error occurs.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.9.0) Use the overloaded multipartParser method that takes the allowEmptyFiles flag

  3. def partParser[A](maxMemoryBufferSize: Long, errorHandler: HttpErrorHandler)(partHandler: Accumulator[Part[Source[ByteString, _]], Either[Result, A]])(implicit mat: Materializer): BodyParser[A]

    Parses the stream into a stream of play.api.mvc.MultipartFormData.Part to be handled by partHandler.

    Parses the stream into a stream of play.api.mvc.MultipartFormData.Part to be handled by partHandler.

    maxMemoryBufferSize

    The maximum amount of data to parse into memory.

    errorHandler

    The error handler to call when an error occurs.

    partHandler

    The accumulator to handle the parts.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.9.0) Use the overloaded partParser method that takes the allowEmptyFiles flag

Inherited from AnyRef

Inherited from Any

Ungrouped