object BasicDirectives extends BasicDirectives

Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. BasicDirectives
  2. BasicDirectives
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Basic directives

  1. def cancelRejection(rejection: Rejection): Directive0

    Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.

    Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.

    Definition Classes
    BasicDirectives
  2. def cancelRejections(cancelFilter: (Rejection) => Boolean): Directive0

    Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.

    Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.

    Definition Classes
    BasicDirectives
  3. def cancelRejections(classes: Class[_]*): Directive0

    Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.

    Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.

    Definition Classes
    BasicDirectives
  4. def extract[T](f: (RequestContext) => T): Directive1[T]

    Extracts a single value using the given function.

    Extracts a single value using the given function.

    Definition Classes
    BasicDirectives
  5. def extractActorSystem: Directive1[ActorSystem]

    Extracts the akka.actor.ActorSystem if the available Materializer is an akka.stream.ActorMaterializer.

    Extracts the akka.actor.ActorSystem if the available Materializer is an akka.stream.ActorMaterializer. Otherwise throws an exception as it won't be able to extract the system from arbitrary materializers.

    Definition Classes
    BasicDirectives
  6. def extractDataBytes: Directive1[Source[ByteString, Any]]

    Extracts the entities dataBytes akka.stream.scaladsl.Source from the akka.http.scaladsl.server.RequestContext.

    Definition Classes
    BasicDirectives
  7. def extractExecutionContext: Directive1[ExecutionContextExecutor]

    Extracts the scala.concurrent.ExecutionContextExecutor from the akka.http.scaladsl.server.RequestContext.

  8. def extractLog: Directive1[LoggingAdapter]

    Extracts the akka.event.LoggingAdapter from the akka.http.scaladsl.server.RequestContext.

  9. def extractMatchedPath: Directive1[Path]

    Extracts the already matched path from the RequestContext.

    Extracts the already matched path from the RequestContext.

    Definition Classes
    BasicDirectives
  10. def extractMaterializer: Directive1[Materializer]

    Extracts the akka.stream.Materializer from the akka.http.scaladsl.server.RequestContext.

  11. def extractParserSettings: Directive1[ParserSettings]

    Extracts the akka.http.scaladsl.settings.ParserSettings from the akka.http.scaladsl.server.RequestContext.

  12. def extractRequest: Directive1[HttpRequest]

    Extracts the current HttpRequest instance.

    Extracts the current HttpRequest instance.

    Definition Classes
    BasicDirectives
  13. def extractRequestContext: Directive1[RequestContext]

    Extracts the akka.http.scaladsl.server.RequestContext itself.

    Definition Classes
    BasicDirectives
  14. def extractRequestEntity: Directive1[RequestEntity]

    Extracts the akka.http.scaladsl.model.RequestEntity from the akka.http.scaladsl.server.RequestContext.

  15. def extractSettings: Directive1[RoutingSettings]

    Extracts the RoutingSettings from the akka.http.scaladsl.server.RequestContext.

    Extracts the RoutingSettings from the akka.http.scaladsl.server.RequestContext.

    Definition Classes
    BasicDirectives
  16. def extractStrictEntity(timeout: FiniteDuration, maxBytes: Long): Directive1[Strict]

    WARNING: This will read the entire request entity into memory and effectively disable streaming.

    WARNING: This will read the entire request entity into memory and effectively disable streaming.

    To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

    Converts the HttpEntity from the akka.http.scaladsl.server.RequestContext into an akka.http.scaladsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

    timeout

    The directive is failed if the stream isn't completed after the given timeout.

    Definition Classes
    BasicDirectives
  17. def extractStrictEntity(timeout: FiniteDuration): Directive1[Strict]

    WARNING: This will read the entire request entity into memory and effectively disable streaming.

    WARNING: This will read the entire request entity into memory and effectively disable streaming.

    To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

    Converts the HttpEntity from the akka.http.scaladsl.server.RequestContext into an akka.http.scaladsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

    timeout

    The directive is failed if the stream isn't completed after the given timeout.

    Definition Classes
    BasicDirectives
  18. def extractUnmatchedPath: Directive1[Path]

    Extracts the yet unmatched path from the RequestContext.

    Extracts the yet unmatched path from the RequestContext.

    Definition Classes
    BasicDirectives
  19. def extractUri: Directive1[Uri]

    Extracts the complete request URI.

    Extracts the complete request URI.

    Definition Classes
    BasicDirectives
  20. def mapInnerRoute(f: (Route) => Route): Directive0

    Definition Classes
    BasicDirectives
  21. def mapRejections(f: (Seq[Rejection]) => Seq[Rejection]): Directive0

    Definition Classes
    BasicDirectives
  22. def mapRequest(f: (HttpRequest) => HttpRequest): Directive0

    Definition Classes
    BasicDirectives
  23. def mapRequestContext(f: (RequestContext) => RequestContext): Directive0

    Definition Classes
    BasicDirectives
  24. def mapResponse(f: (HttpResponse) => HttpResponse): Directive0

    Definition Classes
    BasicDirectives
  25. def mapResponseEntity(f: (ResponseEntity) => ResponseEntity): Directive0

    Definition Classes
    BasicDirectives
  26. def mapResponseHeaders(f: (Seq[HttpHeader]) => Seq[HttpHeader]): Directive0

    Definition Classes
    BasicDirectives
  27. def mapRouteResult(f: (RouteResult) => RouteResult): Directive0

    Definition Classes
    BasicDirectives
  28. def mapRouteResultFuture(f: (Future[RouteResult]) => Future[RouteResult]): Directive0

    Definition Classes
    BasicDirectives
  29. def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult]): Directive0

    Definition Classes
    BasicDirectives
  30. def mapRouteResultWith(f: (RouteResult) => Future[RouteResult]): Directive0

    Definition Classes
    BasicDirectives
  31. def mapRouteResultWithPF(f: PartialFunction[RouteResult, Future[RouteResult]]): Directive0

    Definition Classes
    BasicDirectives
  32. def mapSettings(f: (RoutingSettings) => RoutingSettings): Directive0

    Runs the inner route with settings mapped by the given function.

    Runs the inner route with settings mapped by the given function.

    Definition Classes
    BasicDirectives
  33. def mapUnmatchedPath(f: (Path) => Path): Directive0

    Transforms the unmatchedPath of the RequestContext using the given function.

    Transforms the unmatchedPath of the RequestContext using the given function.

    Definition Classes
    BasicDirectives
  34. def pass: Directive0

    A Directive0 that always passes the request on to its inner route (i.e.

    A Directive0 that always passes the request on to its inner route (i.e. does nothing with the request or the response).

    Definition Classes
    BasicDirectives
  35. def provide[T](value: T): Directive1[T]

    Injects the given value into a directive.

    Injects the given value into a directive.

    Definition Classes
    BasicDirectives
  36. def recoverRejections(f: (Seq[Rejection]) => RouteResult): Directive0

    Definition Classes
    BasicDirectives
  37. def recoverRejectionsWith(f: (Seq[Rejection]) => Future[RouteResult]): Directive0

    Definition Classes
    BasicDirectives
  38. def textract[L](f: (RequestContext) => L)(implicit arg0: Tuple[L]): Directive[L]

    Extracts a number of values using the given function.

    Extracts a number of values using the given function.

    Definition Classes
    BasicDirectives
  39. def toStrictEntity(timeout: FiniteDuration, maxBytes: Long): Directive0

    WARNING: This will read the entire request entity into memory and effectively disable streaming.

    WARNING: This will read the entire request entity into memory and effectively disable streaming.

    To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

    Extracts the akka.http.scaladsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

    timeout

    The directive is failed if the stream isn't completed after the given timeout.

    Definition Classes
    BasicDirectives
  40. def toStrictEntity(timeout: FiniteDuration): Directive0

    WARNING: This will read the entire request entity into memory and effectively disable streaming.

    WARNING: This will read the entire request entity into memory and effectively disable streaming.

    To help protect against excessive memory use, the request will be aborted if the request is larger than allowed by the akka.http.parsing.max-to-strict-bytes configuration setting.

    Extracts the akka.http.scaladsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

    timeout

    The directive is failed if the stream isn't completed after the given timeout.

    Definition Classes
    BasicDirectives
  41. def tprovide[L](values: L)(implicit arg0: Tuple[L]): Directive[L]

    Injects the given values into a directive.

    Injects the given values into a directive.

    Definition Classes
    BasicDirectives
  42. def withExecutionContext(ec: ExecutionContextExecutor): Directive0

    Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

    Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

    Definition Classes
    BasicDirectives
  43. def withLog(log: LoggingAdapter): Directive0

    Runs its inner route with the given alternative akka.event.LoggingAdapter.

    Runs its inner route with the given alternative akka.event.LoggingAdapter.

    Definition Classes
    BasicDirectives
  44. def withMaterializer(materializer: Materializer): Directive0

    Runs its inner route with the given alternative akka.stream.Materializer.

    Runs its inner route with the given alternative akka.stream.Materializer.

    Definition Classes
    BasicDirectives
  45. def withSettings(settings: RoutingSettings): Directive0

    Runs its inner route with the given alternative RoutingSettings.

    Runs its inner route with the given alternative RoutingSettings.

    Definition Classes
    BasicDirectives