request

Type Members

type %>[A, B] = View[A, B]

A symbolic alias for View.
trait DecodeAnyRequest extends AnyRef

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

A magnet that wraps a DecodeRequest.
trait DecodeRequest[+A] extends AnyRef

An abstraction that is responsible for decoding the request of type A.
type FileUpload = org.jboss.netty.handler.codec.http.multipart.FileUpload

A type alias for a org.jboss.netty.handler.codec.http.multipart.FileUpload to prevent imports.
trait LowPriorityRequestReaderImplicits extends AnyRef

Trait with low-priority implicits to avoid conflicts that would arise from adding implicits that would work with any type in the same scope as implicits for concrete types.
Trait with low-priority implicits to avoid conflicts that would arise from adding implicits that would work with any type in the same scope as implicits for concrete types.
Implicits defined in super-types have lower priority than those defined in a sub-type. Therefore we define low- priority implicits here and mix this trait into the package object.
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.
An exception that indicates that a request item could be parsed.
item
the invalid request item
targetType
the type the item should be converted into
cause
the cause of the parsing error
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.
An exception that indicates a required request item (header, param, cookie, body) was missing in the request.
item
the missing request item
case class NotValid(item: RequestItem, rule: String) extends RequestError with Product with Serializable

An exception that indicates a broken ValidationRule]] on the request item.
An exception that indicates a broken ValidationRule]] on the request item.
item
the invalid request item
rule
the rule description
implicit final class OptionReaderOps[R, A] extends AnyVal

Implicit conversion that adds convenience methods to readers for optional values.
trait PRequestReader[R, A] extends AnyRef

A polymorphic request reader (a reader monad) that reads a Future of A from the request of type R.
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.
An exception that collects multiple request reader errors.
errors
the errors collected from various request readers
type RequestReader[A] = PRequestReader[HttpRequest, A]

A PRequestReader with request type fixed to HttpRequest.
implicit class RrArrow1[R, A] extends AnyRef

Adds a ~> and ~~> compositors to RequestReader to compose it with function of one argument.
Adds a ~> and ~~> compositors to RequestReader to compose it with function of one argument.

Definition Classes
LowPriorityRequestReaderImplicits
implicit final class RrArrow2[R, A, B] extends AnyVal

Adds a ~> and ~~> compositors to RequestReader to compose it with function of two arguments.
implicit final class RrArrow3[R, A, B, C] extends AnyVal

Adds a ~> and ~~> compositors to RequestReader to compose it with function of three arguments.
implicit final class RrArrow4[R, A, B, C, D] extends AnyVal

Adds a ~> and ~~> compositors to RequestReader to compose it with function of four arguments.
implicit final class RrArrow5[R, A, B, C, D, E] extends AnyVal

Adds a ~> and ~~> compositors to RequestReader to compose it with function of five arguments.
implicit final class RrArrow6[R, A, B, C, D, E, F] extends AnyVal

Adds a ~> and ~~> compositors to RequestReader to compose it with function of six arguments.
implicit final class RrArrow7[R, A, B, C, D, E, F, G] extends AnyVal

Adds a ~> and ~~> compositors to RequestReader to compose it with function of seven arguments.
implicit final class RrArrow8[R, A, B, C, D, E, F, G, H] extends AnyVal

Adds a ~> and ~~> compositors to RequestReader to compose it with function of eight arguments.
implicit final class StringOptionReaderOps[R] extends AnyVal

Implicit conversion that allows to call as[A] on any RequestReader[Option[String]] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
Implicit conversion that allows to call as[A] on any RequestReader[Option[String]] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
The resulting reader will fail when the result is non-empty and type conversion fails. It will succeed if the result is empty or type conversion succeeds.
implicit final class StringReaderOps[R] extends AnyVal

Implicit conversion that allows to call as[A] on any RequestReader[String] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
Implicit conversion that allows to call as[A] on any RequestReader[String] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
The resulting reader will fail when type conversion fails.
implicit class StringSeqReaderOps[R] extends AnyRef

Implicit conversion that allows to call as[A] on any RequestReader[Seq[String]] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
Implicit conversion that allows to call as[A] on any RequestReader[Seq[String]] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
The resulting reader will fail when the result is non-empty and type conversion fails on one or more of the elements in the Seq. It will succeed if the result is empty or type conversion succeeds for all elements.
trait ValidationRule[A] extends AnyRef

A reusable validation rule that can be applied to any RequestReader with a matching type.
trait View[A, B] extends AnyRef

A sane and safe approach to implicit view A => B.
A sane and safe approach to implicit view A => B.

Annotations
@implicitNotFound( ... )
case class ~[+A, +B](_1: A, _2: B) extends Product with Serializable

A wrapper for two result values.

Value Members

object DecodeRequest

Convenience method for creating new DecodeRequest instances.
object RequestReader

Convenience methods for creating new reader instances.
object ValidationRule

Allows the creation of reusable validation rules for RequestReaders.
object View

A companion object for View.
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.
implicit val decodeBoolean: DecodeRequest[Boolean]

A DecodeRequest instance for Boolean.
implicit val decodeDouble: DecodeRequest[Double]

A DecodeRequest instance for Double.
implicit val decodeFloat: DecodeRequest[Float]

A DecodeRequest instance for Float.
implicit val decodeInt: DecodeRequest[Int]

A DecodeRequest instance for Int.
implicit val decodeLong: DecodeRequest[Long]

A DecodeRequest instance for Long.
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.
implicit def magnetFromAnyDecode[A](implicit d: DecodeAnyRequest, tag: ClassTag[A]): DecodeMagnet[A]

Creates a DecodeMagnet from DecodeAnyRequest.
Creates a DecodeMagnet from DecodeAnyRequest.

Definition Classes
LowPriorityRequestReaderImplicits
implicit def magnetFromDecode[A](implicit d: DecodeRequest[A]): DecodeMagnet[A]

Creates a DecodeMagnet from DecodeRequest.
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.
```
OptionalIntParam("foo").should("be greater than 50") { i: Int => i > 50 }
```
fn
the underlying function to convert
implicit def toOptionalRule[A](rule: ValidationRule[A]): ValidationRule[Option[A]]

Implicit conversion that allows the same ValudationRule to be used for required and optional values.
Implicit conversion that allows the same ValudationRule to be used for required and optional values. If the optional value is non-empty, it gets validated (and validation may fail, producing an error), but if it is empty, it is always treated as valid.
rule
the validation rule to adapt for optional values
returns
a new validation rule that applies the specified rule to an optional value in case it is not empty

Deprecated Value Members

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

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

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use binaryBodyOption instead.
val OptionalBody: RequestReader[Option[String]]

A RequestReader that reads the request body, interpreted as a String, into an Option.
A RequestReader that reads the request body, interpreted as a String, into an Option.

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use bodyOption instead.
def OptionalCookie(name: String): RequestReader[Option[Cookie]]

Creates a RequestReader that reads an optional cookie from the request.
Creates a RequestReader that reads an optional cookie from the request.
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.

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use cookieOption(name) instead.
def OptionalHeader(name: String): RequestReader[Option[String]]

Creates a RequestReader that reads an optional string header from the request into an Option.
Creates a RequestReader that reads an optional string header 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

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use headerOption(name) instead.
def OptionalParam(param: String): RequestReader[Option[String]]

Creates a RequestReader that reads an optional string param from the request into an Option.
Creates a RequestReader that reads an optional string param from the request into an Option.
param
the param to read
returns
an Option that contains a param value or None if the param is empty

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use paramOption(name) instead
def OptionalParams(param: String): RequestReader[Seq[String]]

Creates a RequestReader that reads an optional multi-value string param from the request into a Seq.
Creates a RequestReader that reads an optional multi-value string param from the request into a Seq.
param
the param to read
returns
a Seq that contains all the values of multi-value param or an empty seq Nil if the param is missing or empty.

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use params(name) instead.
val RequiredBinaryBody: RequestReader[Array[Byte]]

A RequestReader that reads an optional binary request body, interpreted as a Array[Byte], or throws a NotPresent exception.
A RequestReader that reads an optional binary request body, interpreted as a Array[Byte], or throws a NotPresent exception.

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use binaryBody instead.
val RequiredBody: RequestReader[String]

A RequestReader that reads the request body, interpreted as a String, or throws a NotPresent exception.
A RequestReader that reads the request body, interpreted as a String, or throws a NotPresent exception.

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use body instead.
def RequiredCookie(cookie: 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.
cookie
the name of the cookie to read
returns
the cookie

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use cookie(name) instead.
def RequiredHeader(name: String): RequestReader[String]

Creates a RequestReader that reads a required string header from the request or raises a NotPresent exception when the header is missing.
Creates a RequestReader that reads a required string header from the request or raises a NotPresent exception when the header is missing.
name
the header to read
returns
a header

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use header(name) instead.
def RequiredParam(name: String): RequestReader[String]

Creates a RequestReader that reads a required string param from the request or raises a NotPresent exception when the param is missing or empty.
Creates a RequestReader that reads a required string param from the request or raises a NotPresent exception when the param is missing or empty.
name
the param name to read
returns
a param value

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use param(name) instead
def RequiredParams(param: String): RequestReader[Seq[String]]

Creates a RequestReader that reads a required multi-value string param from the request into a Seq or raises a NotPresent exception when the param is missing or empty.
Creates a RequestReader that reads a required multi-value string param from the request into a Seq or raises a NotPresent exception when the param is missing or empty.
param
the param to read
returns
a Seq that contains all the values of multi-value param

Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use paramsNonEmpty(name) instead.

package request

Type Members

type %>[A, B] = View[A, B]

trait DecodeAnyRequest extends AnyRef

trait DecodeMagnet[A] extends AnyRef

trait DecodeRequest[+A] extends AnyRef

type FileUpload = org.jboss.netty.handler.codec.http.multipart.FileUpload

trait LowPriorityRequestReaderImplicits 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

implicit final class OptionReaderOps[R, A] extends AnyVal

trait PRequestReader[R, A] extends AnyRef

class RequestError extends Exception

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

type RequestReader[A] = PRequestReader[HttpRequest, A]

implicit class RrArrow1[R, A] extends AnyRef

implicit final class RrArrow2[R, A, B] extends AnyVal

implicit final class RrArrow3[R, A, B, C] extends AnyVal

implicit final class RrArrow4[R, A, B, C, D] extends AnyVal

implicit final class RrArrow5[R, A, B, C, D, E] extends AnyVal

implicit final class RrArrow6[R, A, B, C, D, E, F] extends AnyVal

implicit final class RrArrow7[R, A, B, C, D, E, F, G] extends AnyVal

implicit final class RrArrow8[R, A, B, C, D, E, F, G, H] extends AnyVal

implicit final class StringOptionReaderOps[R] extends AnyVal

implicit final class StringReaderOps[R] extends AnyVal

implicit class StringSeqReaderOps[R] extends AnyRef

trait ValidationRule[A] extends AnyRef

trait View[A, B] extends AnyRef

case class ~[+A, +B](_1: A, _2: B) extends Product with Serializable

Value Members

object DecodeRequest

object RequestReader

object ValidationRule

object View

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]]

implicit val decodeBoolean: DecodeRequest[Boolean]

implicit val decodeDouble: DecodeRequest[Double]

implicit val decodeFloat: DecodeRequest[Float]

implicit val decodeInt: DecodeRequest[Int]

implicit val decodeLong: DecodeRequest[Long]

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

implicit def magnetFromAnyDecode[A](implicit d: DecodeAnyRequest, tag: ClassTag[A]): DecodeMagnet[A]

implicit def magnetFromDecode[A](implicit d: DecodeRequest[A]): DecodeMagnet[A]

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

implicit def toOptionalRule[A](rule: ValidationRule[A]): ValidationRule[Option[A]]

Deprecated Value Members

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

val OptionalBody: RequestReader[Option[String]]

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

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

def OptionalParam(param: String): RequestReader[Option[String]]

def OptionalParams(param: String): RequestReader[Seq[String]]

val RequiredBinaryBody: RequestReader[Array[Byte]]

val RequiredBody: RequestReader[String]

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

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

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

def RequiredParams(param: String): RequestReader[Seq[String]]

Inherited from LowPriorityRequestReaderImplicits

Inherited from AnyRef

Inherited from Any