trait BasicDirectives extends AnyRef
- Grouped
- Alphabetic
- By Inheritance
- BasicDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Basic directives
- 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.
- 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.
- 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.
- def extract[T](f: (RequestContext) => T): Directive1[T]
Extracts a single value using the given function.
- 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.
- def extractDataBytes: Directive1[Source[ByteString, Any]]
Extracts the entities
dataBytes
akka.stream.scaladsl.Source from the akka.http.scaladsl.server.RequestContext. - def extractExecutionContext: Directive1[ExecutionContextExecutor]
Extracts the scala.concurrent.ExecutionContextExecutor from the akka.http.scaladsl.server.RequestContext.
- def extractLog: Directive1[LoggingAdapter]
Extracts the akka.event.LoggingAdapter from the akka.http.scaladsl.server.RequestContext.
- def extractMatchedPath: Directive1[Path]
Extracts the already matched path from the RequestContext.
- def extractMaterializer: Directive1[Materializer]
Extracts the akka.stream.Materializer from the akka.http.scaladsl.server.RequestContext.
- def extractParserSettings: Directive1[ParserSettings]
Extracts the akka.http.scaladsl.settings.ParserSettings from the akka.http.scaladsl.server.RequestContext.
- def extractRequest: Directive1[HttpRequest]
Extracts the current HttpRequest instance.
- def extractRequestContext: Directive1[RequestContext]
Extracts the akka.http.scaladsl.server.RequestContext itself.
- def extractRequestEntity: Directive1[RequestEntity]
Extracts the akka.http.scaladsl.model.RequestEntity from the akka.http.scaladsl.server.RequestContext.
- def extractSettings: Directive1[RoutingSettings]
Extracts the RoutingSettings from the akka.http.scaladsl.server.RequestContext.
- 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.
- 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.
- def extractUnmatchedPath: Directive1[Path]
Extracts the yet unmatched path from the RequestContext.
- def extractUri: Directive1[Uri]
Extracts the complete request URI.
- def mapInnerRoute(f: (Route) => Route): Directive0
- def mapRejections(f: (Seq[Rejection]) => Seq[Rejection]): Directive0
- def mapRequest(f: (HttpRequest) => HttpRequest): Directive0
- def mapRequestContext(f: (RequestContext) => RequestContext): Directive0
- def mapResponse(f: (HttpResponse) => HttpResponse): Directive0
- def mapResponseEntity(f: (ResponseEntity) => ResponseEntity): Directive0
- def mapResponseHeaders(f: (Seq[HttpHeader]) => Seq[HttpHeader]): Directive0
- def mapRouteResult(f: (RouteResult) => RouteResult): Directive0
- def mapRouteResultFuture(f: (Future[RouteResult]) => Future[RouteResult]): Directive0
- def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult]): Directive0
- def mapRouteResultWith(f: (RouteResult) => Future[RouteResult]): Directive0
- def mapRouteResultWithPF(f: PartialFunction[RouteResult, Future[RouteResult]]): Directive0
- def mapSettings(f: (RoutingSettings) => RoutingSettings): Directive0
Runs the inner route with settings mapped by the given function.
- def mapUnmatchedPath(f: (Path) => Path): Directive0
Transforms the unmatchedPath of the RequestContext using the given function.
- 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).
- def provide[T](value: T): Directive1[T]
Injects the given value into a directive.
- def recoverRejections(f: (Seq[Rejection]) => RouteResult): Directive0
- def recoverRejectionsWith(f: (Seq[Rejection]) => Future[RouteResult]): Directive0
- def textract[L](f: (RequestContext) => L)(implicit arg0: Tuple[L]): Directive[L]
Extracts a number of values using the given function.
- 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.
- 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.
- def tprovide[L](values: L)(implicit arg0: Tuple[L]): Directive[L]
Injects the given values into a directive.
- def withExecutionContext(ec: ExecutionContextExecutor): Directive0
Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.
- def withLog(log: LoggingAdapter): Directive0
Runs its inner route with the given alternative akka.event.LoggingAdapter.
- def withMaterializer(materializer: Materializer): Directive0
Runs its inner route with the given alternative akka.stream.Materializer.
- def withSettings(settings: RoutingSettings): Directive0
Runs its inner route with the given alternative RoutingSettings.