Object/Trait

akka.http.scaladsl.server.directives

BasicDirectives

Related Docs: trait BasicDirectives | package directives

Permalink

object BasicDirectives extends BasicDirectives

Source
BasicDirectives.scala
Linear Supertypes
BasicDirectives, AnyRef, Any
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. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def cancelRejection(rejection: Rejection): Directive0

    Permalink

    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
  6. def cancelRejections(cancelFilter: (Rejection) ⇒ Boolean): Directive0

    Permalink

    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
  7. def cancelRejections(classes: Class[_]*): Directive0

    Permalink

    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
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def extract[T](f: (RequestContext) ⇒ T): Directive1[T]

    Permalink

    Extracts a single value using the given function.

    Extracts a single value using the given function.

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

    Permalink

    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
  13. def extractDataBytes: Directive1[Source[ByteString, Any]]

    Permalink

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

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

    Permalink

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

  15. def extractLog: Directive1[LoggingAdapter]

    Permalink

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

  16. def extractMatchedPath: Directive1[Path]

    Permalink

    Extracts the already matched path from the RequestContext.

    Extracts the already matched path from the RequestContext.

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

    Permalink

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

  18. def extractParserSettings: Directive1[ParserSettings]

    Permalink

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

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

    Definition Classes
    BasicDirectives
  19. def extractRequest: Directive1[HttpRequest]

    Permalink

    Extracts the current HttpRequest instance.

    Extracts the current HttpRequest instance.

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

    Permalink

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

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

    Permalink

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

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

    Definition Classes
    BasicDirectives
  22. def extractSettings: Directive1[RoutingSettings]

    Permalink

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

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

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

    Permalink

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

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

    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
  24. def extractUnmatchedPath: Directive1[Path]

    Permalink

    Extracts the yet unmatched path from the RequestContext.

    Extracts the yet unmatched path from the RequestContext.

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

    Permalink

    Extracts the complete request URI.

    Extracts the complete request URI.

    Definition Classes
    BasicDirectives
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def mapInnerRoute(f: (Route) ⇒ Route): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  31. def mapRejections(f: (Seq[Rejection]) ⇒ Seq[Rejection]): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  32. def mapRequest(f: (HttpRequest) ⇒ HttpRequest): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  33. def mapRequestContext(f: (RequestContext) ⇒ RequestContext): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  34. def mapResponse(f: (HttpResponse) ⇒ HttpResponse): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  35. def mapResponseEntity(f: (ResponseEntity) ⇒ ResponseEntity): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  36. def mapResponseHeaders(f: (Seq[HttpHeader]) ⇒ Seq[HttpHeader]): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  37. def mapRouteResult(f: (RouteResult) ⇒ RouteResult): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  38. def mapRouteResultFuture(f: (Future[RouteResult]) ⇒ Future[RouteResult]): Directive0

    Permalink

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

    Permalink

    Definition Classes
    BasicDirectives
  40. def mapRouteResultWith(f: (RouteResult) ⇒ Future[RouteResult]): Directive0

    Permalink

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

    Permalink

    Definition Classes
    BasicDirectives
  42. def mapSettings(f: (RoutingSettings) ⇒ RoutingSettings): Directive0

    Permalink

    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
  43. def mapUnmatchedPath(f: (Path) ⇒ Path): Directive0

    Permalink

    Transforms the unmatchedPath of the RequestContext using the given function.

    Transforms the unmatchedPath of the RequestContext using the given function.

    Definition Classes
    BasicDirectives
  44. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  45. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  47. def pass: Directive0

    Permalink

    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
  48. def provide[T](value: T): Directive1[T]

    Permalink

    Injects the given value into a directive.

    Injects the given value into a directive.

    Definition Classes
    BasicDirectives
  49. def recoverRejections(f: (Seq[Rejection]) ⇒ RouteResult): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  50. def recoverRejectionsWith(f: (Seq[Rejection]) ⇒ Future[RouteResult]): Directive0

    Permalink

    Definition Classes
    BasicDirectives
  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  52. def textract[L](f: (RequestContext) ⇒ L)(implicit arg0: Tuple[L]): Directive[L]

    Permalink

    Extracts a number of values using the given function.

    Extracts a number of values using the given function.

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

    Permalink

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

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

    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
  54. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  55. def tprovide[L](values: L)(implicit arg0: Tuple[L]): Directive[L]

    Permalink

    Injects the given values into a directive.

    Injects the given values into a directive.

    Definition Classes
    BasicDirectives
  56. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. def withExecutionContext(ec: ExecutionContextExecutor): Directive0

    Permalink

    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
  60. def withLog(log: LoggingAdapter): Directive0

    Permalink

    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
  61. def withMaterializer(materializer: Materializer): Directive0

    Permalink

    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
  62. def withSettings(settings: RoutingSettings): Directive0

    Permalink

    Runs its inner route with the given alternative RoutingSettings.

    Runs its inner route with the given alternative RoutingSettings.

    Definition Classes
    BasicDirectives

Inherited from BasicDirectives

Inherited from AnyRef

Inherited from Any

Basic directives

Ungrouped