optionalHeaderValuePF

optionalHeaderValuePF

Signature

Description

Calls the specified partial function with the first request header the function is isDefinedAt and extracts the result of calling the function.

The optionalHeaderValuePF directive is similar to the headerValuePF directive but always extracts an Option value instead of rejecting the request if no matching header could be found.

Example

def extractHostPort: PartialFunction[HttpHeader, Int] = {
  case h: `Host` => h.port
}

val route =
  optionalHeaderValuePF(extractHostPort) {
    case Some(port) => complete(s"The port was $port")
    case None       => complete(s"The port was not provided explicitly")
  } ~ // can also be written as:
    optionalHeaderValuePF(extractHostPort) { port =>
      complete {
        port match {
          case Some(p) => s"The port was $p"
          case _       => "The port was not provided explicitly"
        }
      }
    }

// tests:
Get("/") ~> Host("example.com", 5043) ~> route ~> check {
  responseAs[String] shouldEqual "The port was 5043"
}
Get("/") ~> Route.seal(route) ~> check {
  responseAs[String] shouldEqual "The port was not provided explicitly"
}

Contents