object Route

Source
Route.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Route
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def apply(f: Route): Route

    Helper for constructing a Route from a function literal.

  2. def asyncHandler(route: Route)(implicit routingSettings: RoutingSettings, parserSettings: ParserSettings, materializer: Materializer, routingLog: RoutingLog, executionContext: ExecutionContextExecutor = null, rejectionHandler: RejectionHandler = RejectionHandler.default, exceptionHandler: ExceptionHandler = null): (HttpRequest) ⇒ Future[HttpResponse]

    Turns a Route into an async handler function.

  3. def handlerFlow(route: Route)(implicit routingSettings: RoutingSettings, parserSettings: ParserSettings, materializer: Materializer, routingLog: RoutingLog, executionContext: ExecutionContextExecutor = null, rejectionHandler: RejectionHandler = RejectionHandler.default, exceptionHandler: ExceptionHandler = null): Flow[HttpRequest, HttpResponse, NotUsed]

    Turns a Route into a server flow.

    Turns a Route into a server flow.

    This conversion is also implicitly available through RouteResult#route2HandlerFlow.

  4. def seal(route: Route)(implicit routingSettings: RoutingSettings = null, parserSettings: ParserSettings = null, rejectionHandler: RejectionHandler = RejectionHandler.default, exceptionHandler: ExceptionHandler = null): Route

    "Seals" a route by wrapping it with default exception handling and rejection conversion.

    "Seals" a route by wrapping it with default exception handling and rejection conversion.

    A sealed route has these properties:

    • The result of the route will always be a complete response, i.e. the result of the future is a Success(RouteResult.Complete(response)), never a failed future and never a rejected route. These will be already be handled using the implicitly given RejectionHandler and ExceptionHandler (or the default handlers if none are given or can be found implicitly).
    • Consequently, no route alternatives will be tried that were combined with this route using the ~ on routes or the Directive.| operator on directives.