Documentation for requireThatR and paramR

[bryce-anderson]

The two aforementioned methods allow one to define a route requirement that can return an arbitrary response. An example is thus:

val requireCookie = requireThatR(headers.Cookie){ cookie =>
    cookie.values.toList.find(c => c.name == "Foo" && c.content == "bar") match {
      case Some(_) => None   // Cookie found, good to go.
      case None => // Didn't find cookie
        Some(TemporaryRedirect(uri("/addcookie")))
    }
}

I'm not sure the semantics are perfect: its counter intuitive to interpret a None as a 'success'.

[aryairani]

One alternative would be Failure \/ Unit, but maybe a custom Pass/Fail extends RequirementResult type (or something) would be clearer

[bryce-anderson]

Wow, this has been on the shelf for a long time hasn't it? Any strong feelings on this issue? I'm slightly leaning toward a custom Pass / Fail but the available unambiguous names in the domain are pretty sparse... Maybe Continue and Abort(msg)?