Packages

object Route

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

Value Members

  1. def apply(f: Route): Route

    Helper for constructing a Route from a function literal.

  2. 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.
  3. def toFlow(route: Route)(implicit system: ClassicActorSystemProvider): Flow[HttpRequest, HttpResponse, NotUsed]

    Turns a Route into a server flow.

    Turns a Route into a server flow.

    This conversion is also implicitly available wherever a Route is used through RouteResult#routeToFlow.

  4. def toFunction(route: Route)(implicit system: ClassicActorSystemProvider): (HttpRequest) => Future[HttpResponse]

Deprecated Value Members

  1. 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.

    Turns a Route into an async handler function.

    Annotations
    @deprecated
    Deprecated

    (Since version 10.2.0) Use toFunction instead, which only requires an implicit ActorSystem and no rejection/exception handlers. Use directives to specify custom exceptions or rejection handlers

  2. 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 10.2.0) Replaced by toFlow that takes an implicit ActorSystem.