Trait/Object

akka.http.scaladsl.server.directives

BasicDirectives

Related Docs: object BasicDirectives | package directives

Permalink

trait BasicDirectives extends AnyRef

Source
BasicDirectives.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. BasicDirectives
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  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. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to any2stringadd[BasicDirectives] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BasicDirectives, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to ArrowAssoc[BasicDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  7. 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.

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

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

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (BasicDirectives) ⇒ Boolean, msg: ⇒ Any): BasicDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to Ensuring[BasicDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (BasicDirectives) ⇒ Boolean): BasicDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to Ensuring[BasicDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): BasicDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to Ensuring[BasicDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): BasicDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to Ensuring[BasicDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink

    Extracts a single value using the given function.

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

  19. def extractDataBytes: Directive1[Source[ByteString, Any]]

    Permalink

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

  20. def extractExecutionContext: Directive1[ExecutionContextExecutor]

    Permalink

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

  21. def extractLog: Directive1[LoggingAdapter]

    Permalink

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

  22. def extractMatchedPath: Directive1[Path]

    Permalink

    Extracts the already matched path from the RequestContext.

  23. def extractMaterializer: Directive1[Materializer]

    Permalink

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

  24. def extractParserSettings: Directive1[ParserSettings]

    Permalink

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

  25. def extractRequest: Directive1[HttpRequest]

    Permalink

    Extracts the current HttpRequest instance.

  26. def extractRequestContext: Directive1[RequestContext]

    Permalink

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

  27. def extractRequestEntity: Directive1[RequestEntity]

    Permalink

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

  28. def extractSettings: Directive1[RoutingSettings]

    Permalink

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

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

  30. def extractUnmatchedPath: Directive1[Path]

    Permalink

    Extracts the yet unmatched path from the RequestContext.

  31. def extractUri: Directive1[Uri]

    Permalink

    Extracts the complete request URI.

  32. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to StringFormat[BasicDirectives] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  34. final def getClass(): Class[_]

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

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

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

    Permalink

  38. def mapRejections(f: (Seq[Rejection]) ⇒ Seq[Rejection]): Directive0

    Permalink

  39. def mapRequest(f: (HttpRequest) ⇒ HttpRequest): Directive0

    Permalink

  40. def mapRequestContext(f: (RequestContext) ⇒ RequestContext): Directive0

    Permalink

  41. def mapResponse(f: (HttpResponse) ⇒ HttpResponse): Directive0

    Permalink

  42. def mapResponseEntity(f: (ResponseEntity) ⇒ ResponseEntity): Directive0

    Permalink

  43. def mapResponseHeaders(f: (Seq[HttpHeader]) ⇒ Seq[HttpHeader]): Directive0

    Permalink

  44. def mapRouteResult(f: (RouteResult) ⇒ RouteResult): Directive0

    Permalink

  45. def mapRouteResultFuture(f: (Future[RouteResult]) ⇒ Future[RouteResult]): Directive0

    Permalink

  46. def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult]): Directive0

    Permalink

  47. def mapRouteResultWith(f: (RouteResult) ⇒ Future[RouteResult]): Directive0

    Permalink

  48. def mapRouteResultWithPF(f: PartialFunction[RouteResult, Future[RouteResult]]): Directive0

    Permalink

  49. def mapSettings(f: (RoutingSettings) ⇒ RoutingSettings): Directive0

    Permalink

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

  50. def mapUnmatchedPath(f: (Path) ⇒ Path): Directive0

    Permalink

    Transforms the unmatchedPath of the RequestContext using the given function.

  51. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  54. 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).

  55. def provide[T](value: T): Directive1[T]

    Permalink

    Injects the given value into a directive.

  56. def recoverRejections(f: (Seq[Rejection]) ⇒ RouteResult): Directive0

    Permalink

  57. def recoverRejectionsWith(f: (Seq[Rejection]) ⇒ Future[RouteResult]): Directive0

    Permalink

  58. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink

    Extracts a number of values using the given function.

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

  61. def toString(): String

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

    Permalink

    Injects the given values into a directive.

  63. final def wait(): Unit

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

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

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

    Permalink

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

  67. def withLog(log: LoggingAdapter): Directive0

    Permalink

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

  68. def withMaterializer(materializer: Materializer): Directive0

    Permalink

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

  69. def withSettings(settings: RoutingSettings): Directive0

    Permalink

    Runs its inner route with the given alternative RoutingSettings.

  70. def [B](y: B): (BasicDirectives, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BasicDirectives to ArrowAssoc[BasicDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BasicDirectives to any2stringadd[BasicDirectives]

Inherited by implicit conversion StringFormat from BasicDirectives to StringFormat[BasicDirectives]

Inherited by implicit conversion Ensuring from BasicDirectives to Ensuring[BasicDirectives]

Inherited by implicit conversion ArrowAssoc from BasicDirectives to ArrowAssoc[BasicDirectives]

Basic directives

Ungrouped