Route

org.apache.pekko.http.scaladsl.server.Route
object Route

Attributes

Source
Route.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Route.type

Members list

Value members

Concrete methods

def apply(f: Route): Route

Helper for constructing a Route from a function literal.

Helper for constructing a Route from a function literal.

Attributes

Source
Route.scala
def seal(route: Route)(implicit routingSettings: RoutingSettings, parserSettings: ParserSettings, rejectionHandler: RejectionHandler, exceptionHandler: ExceptionHandler): 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.

Attributes

Source
Route.scala

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.

Attributes

Source
Route.scala

Attributes

Source
Route.scala

Deprecated methods

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

Turns a Route into an async handler function.

Turns a Route into an async handler function.

Attributes

Deprecated
true
Source
Route.scala
def handlerFlow(route: Route)(implicit routingSettings: RoutingSettings, parserSettings: ParserSettings, materializer: Materializer, routingLog: RoutingLog, executionContext: ExecutionContextExecutor, rejectionHandler: RejectionHandler, exceptionHandler: ExceptionHandler): Flow[HttpRequest, HttpResponse, NotUsed]

Turns a Route into a server flow.

Turns a Route into a server flow.

Attributes

Deprecated
true
Source
Route.scala