RequestReader

A RequestReader (a reader monad) that reads a Future of A from the request of type R. RequestReaders might be composed with each other using either monadic API (flatMap method) or applicative API (:: method). Regardless the API used for RequestReaders composition, the main idea behind it is to use primitive readers (i.e., param, paramOption) in order to _compose_ them together and _map_ to the application domain data.

case class Complex(r: Double, i: Double)
val complex: RequestReader[Complex] = (
  param("real").as[Double] ::
  paramOption("imaginary").as[Double].withDefault(0.0)
).as[Complex]

Self Type: RequestReader[A]

Linear Supertypes

AnyRef, Any

Abstract Value Members

abstract def apply(req: Request): Future[A]

Reads the data from given request req.
Reads the data from given request req.
req
the request to read
abstract def item: RequestItem

A RequestItem read by this request reader.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def embedFlatMap[B](fn: (A) ⇒ Future[B]): RequestReader[B]

Flat-maps this request reader to the given function A => Future[B].
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flatMap[B](fn: (A) ⇒ RequestReader[B]): RequestReader[B]

Flat-maps this request reader to the given function A => RequestReader[B].
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lift: RequestReader[Option[A]]

Lifts this request reader into one that always succeeds, with an empty option representing failure.
def map[B](fn: (A) ⇒ B): RequestReader[B]

Maps this request reader to the given function A => B.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def should(rule: ValidationRule[A]): RequestReader[A]

Validates the result of this request reader using a predefined rule.
Validates the result of this request reader using a predefined rule. This method allows for rules to be reused across multiple request readers.
rule
the predefined ValidationRule that will return true if the data is valid
returns
a request reader that will return the value of this reader if it is valid. Otherwise the future fails with a NotValid error.
def should(rule: String)(predicate: (A) ⇒ Boolean): RequestReader[A]

Validates the result of this request reader using a predicate.
Validates the result of this request reader using a predicate. The rule is used for error reporting.
rule
text describing the rule being validated
predicate
returns true if the data is valid
returns
a request reader that will return the value of this reader if it is valid. Otherwise the future fails with a NotValid error.
def shouldNot(rule: ValidationRule[A]): RequestReader[A]

Validates the result of this request reader using a predefined rule.
Validates the result of this request reader using a predefined rule. This method allows for rules to be reused across multiple request readers.
rule
the predefined ValidationRule that will return false if the data is valid
returns
a request reader that will return the value of this reader if it is valid. Otherwise the future fails with a NotValid error.
def shouldNot(rule: String)(predicate: (A) ⇒ Boolean): RequestReader[A]

Validates the result of this request reader using a predicate.
Validates the result of this request reader using a predicate. The rule is used for error reporting.
rule
text describing the rule being validated
predicate
returns false if the data is valid
returns
a request reader that will return the value of this reader if it is valid. Otherwise the future fails with a NotValid error.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withFilter(p: (A) ⇒ Boolean): RequestReader[A]

Applies the given filter p to this request reader.

trait RequestReader[A] extends AnyRef

Abstract Value Members

abstract def apply(req: Request): Future[A]

abstract def item: RequestItem

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def embedFlatMap[B](fn: (A) ⇒ Future[B]): RequestReader[B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def flatMap[B](fn: (A) ⇒ RequestReader[B]): RequestReader[B]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def lift: RequestReader[Option[A]]

def map[B](fn: (A) ⇒ B): RequestReader[B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def should(rule: ValidationRule[A]): RequestReader[A]

def should(rule: String)(predicate: (A) ⇒ Boolean): RequestReader[A]

def shouldNot(rule: ValidationRule[A]): RequestReader[A]

def shouldNot(rule: String)(predicate: (A) ⇒ Boolean): RequestReader[A]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withFilter(p: (A) ⇒ Boolean): RequestReader[A]

Inherited from AnyRef

Inherited from Any

Ungrouped