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. def handleFilePartAsTemporaryFile(temporaryFileCreator: TemporaryFileCreator): FilePartHandler[TemporaryFile]
  2. 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.

  3. 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.

Deprecated Value Members

  1. 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

  2. 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