root
API
Generated with
root/play/play.core/play.core.parsers/Multipart

Multipart

play.core.parsers.Multipart
object Multipart

Utilities for handling multipart bodies

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Multipart.type

Members list

Type members

Classlikes

case class FileInfo(partName: String, fileName: String, contentType: Option[String], dispositionType: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

Value members

Concrete methods

def multipartParser[A](maxMemoryBufferSize: Long, allowEmptyFiles: Boolean, 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.

Value parameters

allowEmptyFiles

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

errorHandler

The error handler to call when an error occurs.

filePartHandler

The accumulator to handle the file parts.

maxMemoryBufferSize

The maximum amount of data to parse into memory.

Attributes

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.

Value parameters

allowEmptyFiles

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

errorHandler

The error handler to call when an error occurs.

maxMemoryBufferSize

The maximum amount of data to parse into memory.

partHandler

The accumulator to handle the parts.

Attributes

Deprecated methods

def multipartParser[A](maxMemoryBufferSize: Long, 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.

Value parameters

errorHandler

The error handler to call when an error occurs.

filePartHandler

The accumulator to handle the file parts.

maxMemoryBufferSize

The maximum amount of data to parse into memory.

Attributes

Deprecated

Since 2.9.0. Use the overloaded multipartParser method that takes the allowEmptyFiles flag.

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.

Value parameters

errorHandler

The error handler to call when an error occurs.

maxMemoryBufferSize

The maximum amount of data to parse into memory.

partHandler

The accumulator to handle the parts.

Attributes

Deprecated

Since 2.9.0. Use the overloaded partParser method that takes the allowEmptyFiles flag.

Generated with