trait BodyParser[+A] extends (RequestHeader) => Accumulator[ByteString, Either[Result, A]]
A body parser parses the HTTP request body content.
- A
the body content type
- Self Type
- BodyParser[A]
- Source
- Action.scala
- Alphabetic
- By Inheritance
- BodyParser
- Function1
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def apply(v1: RequestHeader): Accumulator[ByteString, Either[Result, A]]
- Definition Classes
- Function1
Concrete Value Members
- def andThen[A](g: (Accumulator[ByteString, Either[Result, A]]) => A): (RequestHeader) => A
- Definition Classes
- Function1
- Annotations
- @unspecialized()
- def compose[A](g: (A) => RequestHeader): (A) => Accumulator[ByteString, Either[Result, A]]
- Definition Classes
- Function1
- Annotations
- @unspecialized()
- def map[B](f: (A) => B)(implicit ec: ExecutionContext): BodyParser[B]
Uses the provided function to transform the BodyParser's computed result when the request body has been parsed.
Uses the provided function to transform the BodyParser's computed result when the request body has been parsed.
- f
a function for transforming the computed result
- ec
The context to execute the supplied function with. The context is prepared on the calling thread.
- returns
the transformed body parser
- See also
play.api.libs.streams.Accumulator.map
- def mapM[B](f: (A) => Future[B])(implicit ec: ExecutionContext): BodyParser[B]
Like map but allows the map function to execute asynchronously.
Like map but allows the map function to execute asynchronously.
- f
the async function to map the result of the body parser
- ec
The context to execute the supplied function with. The context prepared on the calling thread.
- returns
the transformed body parser
- See also
play.api.libs.streams.Accumulator.mapFuture[B]
- def toString(): String
- Definition Classes
- Function1 → AnyRef → Any
- def validate[B](f: (A) => Either[Result, B])(implicit ec: ExecutionContext): BodyParser[B]
Uses the provided function to validate the BodyParser's computed result when the request body has been parsed.
Uses the provided function to validate the BodyParser's computed result when the request body has been parsed.
The provided function can produce either a direct result, which will short circuit any further Action, or a value of type B.
Example:
def validateJson[A : Reads] = parse.json.validate( _.validate[A].asEither.left.map(e => BadRequest(JsError.toJson(e))) )
- f
the function to validate the computed result of this body parser
- ec
The context to execute the supplied function with. The context is prepared on the calling thread.
- returns
the transformed body parser
- def validateM[B](f: (A) => Future[Either[Result, B]])(implicit ec: ExecutionContext): BodyParser[B]
Like validate but allows the validate function to execute asynchronously.
Like validate but allows the validate function to execute asynchronously.
- f
the async function to validate the computed result of this body parser
- ec
The context to execute the supplied function with. The context is prepared on the calling thread.
- returns
the transformed body parser
- See also