request

Type Members

trait DecodeAnyRequest extends AnyRef

An abstraction that is responsible for decoding the request of general type.
trait DecodeRequest[A] extends AnyRef

An abstraction that is responsible for decoding the request of type A.
case class NotParsed(item: RequestItem, targetType: ClassTag[_], cause: Throwable) extends RequestError with Product with Serializable

An exception that indicates that a request item could be parsed.
case class NotPresent(item: RequestItem) extends RequestError with Product with Serializable

An exception that indicates a required request item (header, param, cookie, body) was missing in the request.
case class NotValid(item: RequestItem, rule: String) extends RequestError with Product with Serializable

An exception that indicates a broken ValidationRule]] on the request item.
class RequestError extends Exception

A base exception of request reader.
case class RequestErrors(errors: Seq[Throwable]) extends RequestError with Product with Serializable

An exception that collects multiple request reader errors.
trait RequestReader[A] extends AnyRef

A RequestReader (a reader monad) that reads a Future of A from the request of type R.
trait ValidationRule[A] extends AnyRef

A ValidationRule enables a reusable way of defining a validation rules in the application domain.

Value Members

object DecodeRequest
object RequestReader

Convenience methods for creating new reader instances.
object ValidationRule

Allows the creation of reusable validation rules for RequestReaders.
def beGreaterThan[A](n: A)(implicit ev: Numeric[A]): ValidationRule[A]

A ValidationRule that makes sure the numeric value is greater than given n.
def beLessThan[A](n: A)(implicit ev: Numeric[A]): ValidationRule[A]

A ValidationRule]] that makes sure the numeric value is less than given n.
def beLongerThan(n: Int): ValidationRule[String]

A ValidationRule]] that makes sure the string value is longer than n symbols.
def beShorterThan(n: Int): ValidationRule[String]

A ValidationRule]] that makes sure the string value is shorter than n symbols.
val binaryBody: RequestReader[Array[Byte]]

A RequestReader that reads a required binary request body, interpreted as a Array[Byte], or throws a NotPresent exception.
val binaryBodyOption: RequestReader[Option[Array[Byte]]]

A RequestReader that reads a binary request body, interpreted as a Array[Byte], into an Option.
val body: RequestReader[String]

A RequestReader that reads the required request body, interpreted as a String, or throws a NotPresent exception.
val bodyOption: RequestReader[Option[String]]

A RequestReader that reads an optional request body, interpreted as a String, into an Option.
def cookie(name: String): RequestReader[Cookie]

Creates a RequestReader that reads a required cookie from the request or raises a NotPresent exception when the cookie is missing.
Creates a RequestReader that reads a required cookie from the request or raises a NotPresent exception when the cookie is missing.
name
the name of the cookie to read
returns
the cookie
def cookieOption(name: String): RequestReader[Option[Cookie]]

Creates a RequestReader that reads an optional HTTP cookie from the request into an Option.
Creates a RequestReader that reads an optional HTTP cookie from the request into an Option.
name
the name of the cookie to read
returns
an Option that contains a cookie or None if the cookie does not exist on the request.
def fileUpload(name: String): RequestReader[FileUpload]

Creates a RequestReader that reads a required file upload from a multipart/form-data request.
Creates a RequestReader that reads a required file upload from a multipart/form-data request.
name
the name of the parameter to read
returns
the file
def fileUploadOption(name: String): RequestReader[Option[FileUpload]]

Creates a RequestReader that reads an optional file upload from a multipart/form-data request into an Option.
Creates a RequestReader that reads an optional file upload from a multipart/form-data request into an Option.
name
the name of the parameter to read
returns
an Option that contains the file or None is the parameter does not exist on the request.
def header(name: String): RequestReader[String]

Creates a RequestReader that reads a required HTTP header name from the request or raises a NotPresent exception when the header is missing.
Creates a RequestReader that reads a required HTTP header name from the request or raises a NotPresent exception when the header is missing.
name
the header to read
returns
a header
def headerOption(name: String): RequestReader[Option[String]]

Creates a RequestReader that reads an optional HTTP header name from the request into an Option.
Creates a RequestReader that reads an optional HTTP header name from the request into an Option.
name
the header to read
returns
an Option that contains a header value or None if the header is not present in the request
object items

Representations for the various types that can be processed with RequestReaders.
def param(name: String): RequestReader[String]

Creates a RequestReader that reads a required query-string param name from the request or raises a NotPresent exception when the param is missing; a NotValid exception is the param is empty.
Creates a RequestReader that reads a required query-string param name from the request or raises a NotPresent exception when the param is missing; a NotValid exception is the param is empty.
name
the param name to read
returns
a param value
def paramOption(name: String): RequestReader[Option[String]]

Creates a RequestReader that reads an optional query-string param name from the request into an Option.
Creates a RequestReader that reads an optional query-string param name from the request into an Option.
name
the param to read
returns
an Option that contains a param value or None if the param is empty
def params(name: String): RequestReader[Seq[String]]

Creates a RequestReader that reads an optional (in a meaning that a resulting Seq may be empty) multi-value query-string param name from the request into a Seq.
Creates a RequestReader that reads an optional (in a meaning that a resulting Seq may be empty) multi-value query-string param name from the request into a Seq.
name
the param to read
returns
a Seq that contains all the values of multi-value param or an empty seq Nil if the params are missing or empty.
def paramsNonEmpty(name: String): RequestReader[Seq[String]]

Creates a RequestReader that reads a required (in a meaning that a resulting Seq will have at least one element) multi-value query-string param name from the request into a Seq or raises a NotPresent exception when the params are missing or empty.
Creates a RequestReader that reads a required (in a meaning that a resulting Seq will have at least one element) multi-value query-string param name from the request into a Seq or raises a NotPresent exception when the params are missing or empty.
name
the param to read
returns
a Seq that contains all the values of multi-value param
implicit def toOptionalInlineRule[A](fn: (A) ⇒ Boolean): (Option[A]) ⇒ Boolean

Implicit conversion that allows the same inline rules to be used for required and optional values.
Implicit conversion that allows the same inline rules to be used for required and optional values. If the optional value is non-empty, it gets validated (and validation may fail, producing error), but if it is empty, it is always treated as valid.
In order to help the compiler determine the case when inline rule should be converted, the type of the validated value should be specified explicitly.
```
paramOption("foo").should("be greater than 50") { i: Int => i > 50 }
```
fn
the underlying function to convert

package request

Type Members

trait DecodeAnyRequest extends AnyRef

trait DecodeRequest[A] extends AnyRef

case class NotParsed(item: RequestItem, targetType: ClassTag[_], cause: Throwable) extends RequestError with Product with Serializable

case class NotPresent(item: RequestItem) extends RequestError with Product with Serializable

case class NotValid(item: RequestItem, rule: String) extends RequestError with Product with Serializable

class RequestError extends Exception

case class RequestErrors(errors: Seq[Throwable]) extends RequestError with Product with Serializable

trait RequestReader[A] extends AnyRef

trait ValidationRule[A] extends AnyRef

Value Members

object DecodeRequest

object RequestReader

object ValidationRule

def beGreaterThan[A](n: A)(implicit ev: Numeric[A]): ValidationRule[A]

def beLessThan[A](n: A)(implicit ev: Numeric[A]): ValidationRule[A]

def beLongerThan(n: Int): ValidationRule[String]

def beShorterThan(n: Int): ValidationRule[String]

val binaryBody: RequestReader[Array[Byte]]

val binaryBodyOption: RequestReader[Option[Array[Byte]]]

val body: RequestReader[String]

val bodyOption: RequestReader[Option[String]]

def cookie(name: String): RequestReader[Cookie]

def cookieOption(name: String): RequestReader[Option[Cookie]]

def fileUpload(name: String): RequestReader[FileUpload]

def fileUploadOption(name: String): RequestReader[Option[FileUpload]]

def header(name: String): RequestReader[String]

def headerOption(name: String): RequestReader[Option[String]]

object items

def param(name: String): RequestReader[String]

def paramOption(name: String): RequestReader[Option[String]]

def params(name: String): RequestReader[Seq[String]]

def paramsNonEmpty(name: String): RequestReader[Seq[String]]

implicit def toOptionalInlineRule[A](fn: (A) ⇒ Boolean): (Option[A]) ⇒ Boolean

Inherited from AnyRef

Inherited from Any

Ungrouped