Packages

trait Directives extends RouteConcatenation with BasicDirectives with CacheConditionDirectives with CookieDirectives with DebuggingDirectives with CodingDirectives with ExecutionDirectives with FileAndResourceDirectives with FileUploadDirectives with FormFieldDirectives with FutureDirectives with HeaderDirectives with HostDirectives with MarshallingDirectives with MethodDirectives with MiscDirectives with ParameterDirectives with TimeoutDirectives with PathDirectives with RangeDirectives with RespondWithDirectives with RouteDirectives with SchemeDirectives with SecurityDirectives with WebSocketDirectives with FramedEntityStreamingDirectives with AttributeDirectives

Collects all default directives into one trait for simple importing.

See akka.http.javadsl.server.AllDirectives for JavaDSL equivalent of this trait.

Source
Directives.scala
Known Subclasses
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Directives
  2. AttributeDirectives
  3. FramedEntityStreamingDirectives
  4. WebSocketDirectives
  5. SecurityDirectives
  6. SchemeDirectives
  7. RouteDirectives
  8. RespondWithDirectives
  9. RangeDirectives
  10. PathDirectives
  11. ImplicitPathMatcherConstruction
  12. PathMatchers
  13. TimeoutDirectives
  14. ParameterDirectives
  15. ParameterDirectivesInstances
  16. MiscDirectives
  17. MethodDirectives
  18. MarshallingDirectives
  19. HostDirectives
  20. HeaderDirectives
  21. FutureDirectives
  22. FormFieldDirectives
  23. ToNameReceptacleEnhancements
  24. FormFieldDirectivesInstances
  25. FileUploadDirectives
  26. FileAndResourceDirectives
  27. ExecutionDirectives
  28. CodingDirectives
  29. DebuggingDirectives
  30. CookieDirectives
  31. CacheConditionDirectives
  32. BasicDirectives
  33. RouteConcatenation
  34. AnyRef
  35. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type AsyncAuthenticator[T] = (Credentials) => Future[Option[T]]

    Definition Classes
    SecurityDirectives
  2. type AsyncAuthenticatorPF[T] = PartialFunction[Credentials, Future[T]]

    Definition Classes
    SecurityDirectives
  3. type AuthenticationResult[+T] = Either[HttpChallenge, T]

    The result of an HTTP authentication attempt is either the user object or an HttpChallenge to present to the browser.

    The result of an HTTP authentication attempt is either the user object or an HttpChallenge to present to the browser.

    Definition Classes
    SecurityDirectives
  4. type Authenticator[T] = (Credentials) => Option[T]

    Definition Classes
    SecurityDirectives
  5. type AuthenticatorPF[T] = PartialFunction[Credentials, T]

    Definition Classes
    SecurityDirectives
  6. type RequestToSourceUnmarshaller[T] = Unmarshaller[HttpRequest, Source[T, NotUsed]]
  7. abstract class NumberMatcher[T] extends PathMatcher1[T]

    Definition Classes
    PathMatchers

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Directives toany2stringadd[Directives] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Directives, B)
    Implicit
    This member is added by an implicit conversion from Directives toArrowAssoc[Directives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val DoubleNumber: PathMatcher1[Double]

    A PathMatcher that matches and extracts a Double value.

    A PathMatcher that matches and extracts a Double value. The matched string representation is the pure decimal, optionally signed form of a double value, i.e. without exponent.

    Definition Classes
    PathMatchers
  7. val JavaUUID: PathMatcher1[UUID]

    A PathMatcher that matches and extracts a java.util.UUID instance.

    A PathMatcher that matches and extracts a java.util.UUID instance.

    Definition Classes
    PathMatchers
  8. val Neutral: PathMatcher0

    A PathMatcher that always matches, doesn't consume anything and extracts nothing.

    A PathMatcher that always matches, doesn't consume anything and extracts nothing. Serves mainly as a neutral element in PathMatcher composition.

    Definition Classes
    PathMatchers
  9. def Segments(min: Int, max: Int): PathMatcher1[List[String]]

    A PathMatcher that matches between min and max (both inclusively) path segments (separated by slashes) as a List[String].

    A PathMatcher that matches between min and max (both inclusively) path segments (separated by slashes) as a List[String]. If there are more than count segments present the remaining ones will be left unmatched. If the path has a trailing slash this slash will *not* be matched.

    Definition Classes
    PathMatchers
  10. def Segments(count: Int): PathMatcher1[List[String]]

    A PathMatcher that matches the given number of path segments (separated by slashes) as a List[String].

    A PathMatcher that matches the given number of path segments (separated by slashes) as a List[String]. If there are more than count segments present the remaining ones will be left unmatched. If the path has a trailing slash this slash will *not* be matched.

    Definition Classes
    PathMatchers
  11. val Segments: PathMatcher1[List[String]]

    A PathMatcher that matches up to 128 remaining segments as a List[String].

    A PathMatcher that matches up to 128 remaining segments as a List[String]. This can also be no segments resulting in the empty list. If the path has a trailing slash this slash will *not* be matched.

    Definition Classes
    PathMatchers
  12. def _defaultClassLoader: ClassLoader
    Attributes
    protected[http]
    Definition Classes
    FileAndResourceDirectives
  13. implicit def _enhanceRouteWithConcatenation(route: Route): RouteWithConcatenation

    Definition Classes
    RouteConcatenation
  14. implicit def _regex2PathMatcher(regex: Regex): PathMatcher1[String]

    Creates a PathMatcher that consumes (a prefix of) the first path segment if the path begins with a segment (a prefix of) which matches the given regex.

    Creates a PathMatcher that consumes (a prefix of) the first path segment if the path begins with a segment (a prefix of) which matches the given regex. Extracts either the complete match (if the regex doesn't contain a capture group) or the capture group (if the regex contains exactly one). If the regex contains more than one capture group the method throws an IllegalArgumentException.

    Definition Classes
    ImplicitPathMatcherConstruction
  15. implicit def _segmentStringToPathMatcher(segment: String): PathMatcher0

    Creates a PathMatcher that consumes (a prefix of) the first path segment (if the path begins with a segment).

    Creates a PathMatcher that consumes (a prefix of) the first path segment (if the path begins with a segment).

    Definition Classes
    ImplicitPathMatcherConstruction
  16. implicit def _string2NR(string: String): NameReceptacle[String]
    Definition Classes
    ToNameReceptacleEnhancements
    Annotations
    @implicitAmbiguous("Akka HTTP's `*` decorator conflicts with Scala's String.`*` method. Use `.repeated` instead.")
  17. implicit def _stringExtractionPair2PathMatcher[T](tuple: (String, T)): PathMatcher1[T]

    Creates a PathMatcher that consumes (a prefix of) the first path segment (if the path begins with a segment) and extracts a given value.

    Creates a PathMatcher that consumes (a prefix of) the first path segment (if the path begins with a segment) and extracts a given value.

    Definition Classes
    ImplicitPathMatcherConstruction
  18. implicit def _stringNameOptionReceptacle2PathMatcher(nr: NameOptionReceptacle[String]): PathMatcher0

  19. implicit def _symbol2NR(symbol: Symbol): NameReceptacle[String]
    Definition Classes
    ToNameReceptacleEnhancements
  20. implicit def _valueMap2PathMatcher[T](valueMap: Map[String, T]): PathMatcher1[T]

    Creates a PathMatcher from the given Map of path segments (prefixes) to extracted values.

    Creates a PathMatcher from the given Map of path segments (prefixes) to extracted values. If the unmatched path starts with a segment having one of the maps keys as a prefix the matcher consumes this path segment (prefix) and extracts the corresponding map value. For keys sharing a common prefix the longest matching prefix is selected.

    Definition Classes
    ImplicitPathMatcherConstruction
  21. def as[T](implicit um: FromRequestUnmarshaller[T]): FromRequestUnmarshaller[T]

    Returns the in-scope FromRequestUnmarshaller for the given type.

    Returns the in-scope FromRequestUnmarshaller for the given type.

    Definition Classes
    MarshallingDirectives
  22. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  23. final def asSourceOf[T](support: EntityStreamingSupport)(implicit um: FromByteStringUnmarshaller[T]): RequestToSourceUnmarshaller[T]

    Extracts entity as akka.stream.scaladsl.Source of elements of type T.

    Extracts entity as akka.stream.scaladsl.Source of elements of type T. This is achieved by applying the implicitly provided (in the following order):

    - 1st: chunk-up the incoming ByteStrings by applying the Content-Type-aware framing - 2nd: apply the Unmarshaller (from ByteString to T) for each of the respective "chunks" (e.g. for each JSON element contained within an array).

    The request will be rejected with an akka.http.scaladsl.server.UnsupportedRequestContentTypeRejection if its ContentType is not supported by the used framing or unmarshaller.

    Cancelling extracted akka.stream.scaladsl.Source closes the connection abruptly (same as cancelling the entity.dataBytes).

    See also MiscDirectives.withoutSizeLimit as you may want to allow streaming infinite streams of data in this route. By default the uploaded data is limited by the akka.http.parsing.max-content-length.

    Definition Classes
    FramedEntityStreamingDirectives
  24. final def asSourceOf[T](implicit um: FromByteStringUnmarshaller[T], support: EntityStreamingSupport): RequestToSourceUnmarshaller[T]

    Extracts entity as akka.stream.scaladsl.Source of elements of type T.

    Extracts entity as akka.stream.scaladsl.Source of elements of type T. This is achieved by applying the implicitly provided (in the following order):

    - 1st: chunk-up the incoming ByteStrings by applying the Content-Type-aware framing - 2nd: apply the Unmarshaller (from ByteString to T) for each of the respective "chunks" (e.g. for each JSON element contained within an array).

    The request will be rejected with an akka.http.scaladsl.server.UnsupportedRequestContentTypeRejection if its ContentType is not supported by the used framing or unmarshaller.

    Cancelling extracted akka.stream.scaladsl.Source closes the connection abruptly (same as cancelling the entity.dataBytes).

    See also MiscDirectives.withoutSizeLimit as you may want to allow streaming infinite streams of data in this route. By default the uploaded data is limited by the akka.http.parsing.max-content-length.

    Definition Classes
    FramedEntityStreamingDirectives
  25. def attribute[T](key: AttributeKey[T]): Directive1[T]

    Extracts a request attribute value for the given key.

    Extracts a request attribute value for the given key.

    Definition Classes
    AttributeDirectives
  26. def authenticateBasic[T](realm: String, authenticator: Authenticator[T]): AuthenticationDirective[T]

    Wraps the inner route with Http Basic authentication support using a given Authenticator[T].

    Wraps the inner route with Http Basic authentication support using a given Authenticator[T]. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  27. def authenticateBasicAsync[T](realm: String, authenticator: AsyncAuthenticator[T]): AuthenticationDirective[T]

    Wraps the inner route with Http Basic authentication support.

    Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  28. def authenticateBasicPF[T](realm: String, authenticator: AuthenticatorPF[T]): AuthenticationDirective[T]

    A directive that wraps the inner route with Http Basic authentication support.

    A directive that wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  29. def authenticateBasicPFAsync[T](realm: String, authenticator: AsyncAuthenticatorPF[T]): AuthenticationDirective[T]

    A directive that wraps the inner route with Http Basic authentication support.

    A directive that wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  30. def authenticateOAuth2[T](realm: String, authenticator: Authenticator[T]): AuthenticationDirective[T]

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support.

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  31. def authenticateOAuth2Async[T](realm: String, authenticator: AsyncAuthenticator[T]): AuthenticationDirective[T]

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support.

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  32. def authenticateOAuth2PF[T](realm: String, authenticator: AuthenticatorPF[T]): AuthenticationDirective[T]

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support.

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  33. def authenticateOAuth2PFAsync[T](realm: String, authenticator: AsyncAuthenticatorPF[T]): AuthenticationDirective[T]

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support.

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  34. def authenticateOrRejectWithChallenge[C <: HttpCredentials, T](authenticator: (Option[C]) => Future[AuthenticationResult[T]])(implicit arg0: ClassTag[C]): AuthenticationDirective[T]

    Lifts an authenticator function into a directive.

    Lifts an authenticator function into a directive. Same as authenticateOrRejectWithChallenge but only applies the authenticator function with a certain type of credentials.

    Definition Classes
    SecurityDirectives
  35. def authenticateOrRejectWithChallenge[T](authenticator: (Option[HttpCredentials]) => Future[AuthenticationResult[T]]): AuthenticationDirective[T]

    Lifts an authenticator function into a directive.

    Lifts an authenticator function into a directive. The authenticator function gets passed in credentials from the Authorization header of the request. If the function returns Right(user) the user object is provided to the inner route. If the function returns Left(challenge) the request is rejected with an AuthenticationFailedRejection that contains this challenge to be added to the response.

    Definition Classes
    SecurityDirectives
  36. def authorize(check: (RequestContext) => Boolean): Directive0

    Applies the given authorization check to the request.

    Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.

    Definition Classes
    SecurityDirectives
  37. def authorize(check: => Boolean): Directive0

    Applies the given authorization check to the request.

    Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.

    Definition Classes
    SecurityDirectives
  38. def authorizeAsync(check: (RequestContext) => Future[Boolean]): Directive0

    Asynchronous version of authorize.

    Asynchronous version of authorize. If the Future fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.

    Definition Classes
    SecurityDirectives
  39. def authorizeAsync(check: => Future[Boolean]): Directive0

    Asynchronous version of authorize.

    Asynchronous version of authorize. If the Future fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.

    Definition Classes
    SecurityDirectives
  40. 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
  41. 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
  42. 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
  43. def checkSameOrigin(allowed: Default): Directive0

    Checks that request comes from the same origin.

    Checks that request comes from the same origin. Extracts the Origin header value and verifies that allowed range contains the obtained value. In the case of absent of the Origin header rejects with MissingHeaderRejection. If the origin value is not in the allowed range rejects with an InvalidOriginRejection and StatusCodes.Forbidden status.

    Definition Classes
    HeaderDirectives
  44. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  45. def complete[T](status: StatusCode, headers: Seq[HttpHeader], v: => T)(implicit m: ToEntityMarshaller[T]): StandardRoute

    Completes the request using the given arguments.

    Completes the request using the given arguments.

    Definition Classes
    RouteDirectives
  46. def complete[T](status: StatusCode, v: => T)(implicit m: ToEntityMarshaller[T]): StandardRoute

    Completes the request using the given arguments.

    Completes the request using the given arguments.

    Definition Classes
    RouteDirectives
  47. def complete(m: => ToResponseMarshallable): StandardRoute

    Completes the request using the given arguments.

    Completes the request using the given arguments.

    Definition Classes
    RouteDirectives
  48. def completeOrRecoverWith(magnet: CompleteOrRecoverWithMagnet): Directive1[Throwable]

    "Unwraps" a Future[T] and runs the inner route when the future has failed with the future's failure exception as an extraction of type Throwable.

    "Unwraps" a Future[T] and runs the inner route when the future has failed with the future's failure exception as an extraction of type Throwable. If the future succeeds the request is completed using the values marshaller (This directive therefore requires a marshaller for the futures type to be implicitly available.)

    Definition Classes
    FutureDirectives
  49. def completeWith[T](marshaller: ToResponseMarshaller[T])(inner: ((T) => Unit) => Unit): Route

    Uses the marshaller for the given type to produce a completion function that is passed to its inner function.

    Uses the marshaller for the given type to produce a completion function that is passed to its inner function. You can use it do decouple marshaller resolution from request completion.

    Definition Classes
    MarshallingDirectives
  50. def concat(routes: Route*): Route

    Tries the supplied routes in sequence, returning the result of the first route that doesn't reject the request.

    Tries the supplied routes in sequence, returning the result of the first route that doesn't reject the request. This is an alternative to direct usage of the infix ~ operator. The ~ can be prone to programmer error, because if it is omitted, the program will still be syntactically correct, but will not actually attempt to match multiple routes, as intended.

    routes

    subroutes to concatenate

    returns

    the concatenated route

    Definition Classes
    RouteConcatenation
  51. def conditional(eTag: Option[EntityTag], lastModified: Option[DateTime]): Directive0

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  52. def conditional(eTag: EntityTag, lastModified: DateTime): Directive0

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  53. def conditional(lastModified: DateTime): Directive0

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  54. def conditional(eTag: EntityTag): Directive0

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  55. def cookie(name: String): Directive1[HttpCookiePair]

    Extracts the HttpCookiePair with the given name.

    Extracts the HttpCookiePair with the given name. If the cookie is not present the request is rejected with a respective MissingCookieRejection.

    Definition Classes
    CookieDirectives
  56. def decodeRequest: Directive0

    Decompresses the incoming request if it is gzip or deflate compressed.

    Decompresses the incoming request if it is gzip or deflate compressed. Uncompressed requests are passed through untouched. If the request encoded with another encoding the request is rejected with an UnsupportedRequestEncodingRejection.

    Definition Classes
    CodingDirectives
  57. def decodeRequestWith(decoders: Decoder*): Directive0

    Decodes the incoming request if it is encoded with one of the given encoders.

    Decodes the incoming request if it is encoded with one of the given encoders. If the request encoding doesn't match one of the given encoders the request is rejected with an UnsupportedRequestEncodingRejection. If no decoders are given the default encoders (Gzip, Deflate, NoCoding) are used.

    Definition Classes
    CodingDirectives
  58. def decodeRequestWith(decoder: Decoder): Directive0

    Decodes the incoming request using the given Decoder.

    Decodes the incoming request using the given Decoder. If the request encoding doesn't match the request is rejected with an UnsupportedRequestEncodingRejection.

    Definition Classes
    CodingDirectives
  59. def delete: Directive0

    Rejects all non-DELETE requests.

    Rejects all non-DELETE requests.

    Definition Classes
    MethodDirectives
  60. def deleteCookie(name: String, domain: String = "", path: String = ""): Directive0

    Adds a Set-Cookie response header expiring the cookie with the given properties.

    Adds a Set-Cookie response header expiring the cookie with the given properties.

    Definition Classes
    CookieDirectives
  61. def deleteCookie(first: HttpCookie, more: HttpCookie*): Directive0

    Adds a Set-Cookie response header expiring the given cookies.

    Adds a Set-Cookie response header expiring the given cookies.

    Definition Classes
    CookieDirectives
  62. def encodeResponse: Directive0

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header.

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

    If the Accept-Encoding header is missing or empty or specifies an encoding other than identity, gzip or deflate then no encoding is used.

    Definition Classes
    CodingDirectives
  63. def encodeResponseWith(first: Encoder, more: Encoder*): Directive0

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header.

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

    If the Accept-Encoding header is missing then the response is encoded using the first encoder.

    If the Accept-Encoding header is empty and NoCoding is part of the encoders then no response encoding is used. Otherwise the request is rejected.

    Definition Classes
    CodingDirectives
  64. def ensuring(cond: (Directives) => Boolean, msg: => Any): Directives
    Implicit
    This member is added by an implicit conversion from Directives toEnsuring[Directives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  65. def ensuring(cond: (Directives) => Boolean): Directives
    Implicit
    This member is added by an implicit conversion from Directives toEnsuring[Directives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  66. def ensuring(cond: Boolean, msg: => Any): Directives
    Implicit
    This member is added by an implicit conversion from Directives toEnsuring[Directives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  67. def ensuring(cond: Boolean): Directives
    Implicit
    This member is added by an implicit conversion from Directives toEnsuring[Directives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  68. def entity[T](um: FromRequestUnmarshaller[T]): Directive1[T]

    Unmarshalls the requests entity to the given type passes it to its inner Route.

    Unmarshalls the requests entity to the given type passes it to its inner Route. If there is a problem with unmarshalling the request is rejected with the Rejection produced by the unmarshaller.

    Definition Classes
    MarshallingDirectives
  69. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  71. 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
  72. 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
  73. def extractClientIP: Directive1[RemoteAddress]

    Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or akka.http.scaladsl.model.AttributeKeys.remoteAddress attribute (in that order of priority).

    Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or akka.http.scaladsl.model.AttributeKeys.remoteAddress attribute (in that order of priority).

    Definition Classes
    MiscDirectives
  74. def extractCredentials: Directive1[Option[HttpCredentials]]

    Extracts the potentially present HttpCredentials provided with the request's Authorization header.

    Extracts the potentially present HttpCredentials provided with the request's Authorization header.

    Definition Classes
    SecurityDirectives
  75. def extractDataBytes: Directive1[Source[ByteString, Any]]

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

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

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

  77. def extractHost: Directive1[String]

    Extracts the hostname part of the Host request header value.

    Extracts the hostname part of the Host request header value.

    Definition Classes
    HostDirectives
  78. def extractLog: Directive1[LoggingAdapter]

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

  79. def extractMatchedPath: Directive1[Path]

    Extracts the already matched path from the RequestContext.

    Extracts the already matched path from the RequestContext.

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

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

  81. def extractMethod: Directive1[HttpMethod]

    Extracts the request method.

    Extracts the request method.

    Definition Classes
    MethodDirectives
  82. def extractOfferedWsProtocols: Directive1[Seq[String]]

    Extract the list of WebSocket subprotocols as offered by the client in the Sec-WebSocket-Protocol header if this is a WebSocket request.

    Extract the list of WebSocket subprotocols as offered by the client in the Sec-WebSocket-Protocol header if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.

    Definition Classes
    WebSocketDirectives
  83. def extractParserSettings: Directive1[ParserSettings]

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

  84. def extractRequest: Directive1[HttpRequest]

    Extracts the current HttpRequest instance.

    Extracts the current HttpRequest instance.

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

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

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

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

  87. def extractRequestTimeout: Directive1[Duration]

    Return the currently set request timeout.

    Return the currently set request timeout.

    Note that this may be changed in inner directives.

    Definition Classes
    TimeoutDirectives
  88. def extractScheme: Directive1[String]

    Extracts the Uri scheme from the request.

    Extracts the Uri scheme from the request.

    Definition Classes
    SchemeDirectives
  89. 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
  90. 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
  91. 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
  92. def extractUnmatchedPath: Directive1[Path]

    Extracts the yet unmatched path from the RequestContext.

    Extracts the yet unmatched path from the RequestContext.

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

    Extracts the complete request URI.

    Extracts the complete request URI.

    Definition Classes
    BasicDirectives
  94. def extractWebSocketUpgrade: Directive1[WebSocketUpgrade]

    Extract the WebSocketUpgrade attribute if this is a WebSocket request.

    Extract the WebSocketUpgrade attribute if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.

    Definition Classes
    WebSocketDirectives
  95. def failWith(error: Throwable): StandardRoute

    Bubbles the given error up the response chain, where it is dealt with by the closest handleExceptions directive and its ExceptionHandler.

    Bubbles the given error up the response chain, where it is dealt with by the closest handleExceptions directive and its ExceptionHandler.

    Definition Classes
    RouteDirectives
  96. def fileUpload(fieldName: String): Directive1[(FileInfo, Source[ByteString, Any])]

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere.

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere. If there is no such field the request will be rejected, if there are multiple file parts with the same name, the first one will be used and the subsequent ones ignored.

    Definition Classes
    FileUploadDirectives
  97. def fileUploadAll(fieldName: String): Directive1[Seq[(FileInfo, Source[ByteString, Any])]]

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere.

    Collects each body part that is a multipart file as a tuple containing metadata and a Source for streaming the file contents somewhere. If there is no such field the request will be rejected. Files are buffered into temporary files on disk so in-memory buffers don't overflow. The temporary files are cleaned up once materialized, or on exit if the stream is not consumed.

    Definition Classes
    FileUploadDirectives
    Annotations
    @ApiMayChange()
  98. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  99. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec, pdef19: FieldSpec, pdef20: FieldSpec, pdef21: FieldSpec, pdef22: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  100. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec, pdef19: FieldSpec, pdef20: FieldSpec, pdef21: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  101. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec, pdef19: FieldSpec, pdef20: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  102. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec, pdef19: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  103. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  104. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  105. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  106. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  107. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  108. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  109. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  110. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  111. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  112. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  113. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  114. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  115. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  116. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec): Directive[(Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  117. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec): Directive[(Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  118. def formField(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec): Directive[(Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  119. def formField(pdef1: FieldSpec, pdef2: FieldSpec): Directive[(Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  120. def formField(pdef1: FieldSpec): Directive[(Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  121. def formFieldMap: Directive1[Map[String, String]]

    Extracts HTTP form fields from the request as a Map[String, String].

    Extracts HTTP form fields from the request as a Map[String, String].

    Definition Classes
    FormFieldDirectives
  122. def formFieldMultiMap: Directive1[Map[String, List[String]]]

    Extracts HTTP form fields from the request as a Map[String, List[String]].

    Extracts HTTP form fields from the request as a Map[String, List[String]].

    Definition Classes
    FormFieldDirectives
  123. def formFieldSeq: Directive1[Seq[(String, String)]]

    Extracts HTTP form fields from the request as a Seq[(String, String)].

    Extracts HTTP form fields from the request as a Seq[(String, String)].

    Definition Classes
    FormFieldDirectives
  124. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec, pdef19: FieldSpec, pdef20: FieldSpec, pdef21: FieldSpec, pdef22: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  125. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec, pdef19: FieldSpec, pdef20: FieldSpec, pdef21: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  126. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec, pdef19: FieldSpec, pdef20: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  127. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec, pdef19: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  128. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec, pdef18: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  129. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec, pdef17: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  130. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec, pdef16: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  131. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec, pdef15: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  132. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec, pdef14: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  133. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec, pdef13: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  134. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec, pdef12: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  135. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec, pdef11: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  136. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec, pdef10: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  137. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec, pdef9: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  138. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec, pdef8: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  139. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec, pdef7: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  140. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec, pdef6: FieldSpec): Directive[(Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  141. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec, pdef5: FieldSpec): Directive[(Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  142. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec, pdef4: FieldSpec): Directive[(Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  143. def formFields(pdef1: FieldSpec, pdef2: FieldSpec, pdef3: FieldSpec): Directive[(Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  144. def formFields(pdef1: FieldSpec, pdef2: FieldSpec): Directive[(Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  145. def formFields(pdef1: FieldSpec): Directive[(Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    FormFieldDirectivesInstances
  146. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Directives toStringFormat[Directives] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  147. def get: Directive0

    Rejects all non-GET requests.

    Rejects all non-GET requests.

    Definition Classes
    MethodDirectives
  148. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  149. def getFromBrowseableDirectories(directories: String*)(implicit renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route

    Serves the content of the given directories as a file system browser, i.e.

    Serves the content of the given directories as a file system browser, i.e. files are sent and directories served as browseable listings.

    Definition Classes
    FileAndResourceDirectives
  150. def getFromBrowseableDirectory(directory: String)(implicit renderer: DirectoryRenderer, resolver: ContentTypeResolver): Route

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

    Definition Classes
    FileAndResourceDirectives
  151. def getFromDirectory(directoryName: String)(implicit resolver: ContentTypeResolver): Route

    Completes GET requests with the content of a file underneath the given directory.

    Completes GET requests with the content of a file underneath the given directory. If the file cannot be read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  152. def getFromFile(file: File, contentType: ContentType): Route

    Completes GET requests with the content of the given file.

    Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.

    Definition Classes
    FileAndResourceDirectives
  153. def getFromFile(file: File)(implicit resolver: ContentTypeResolver): Route

    Completes GET requests with the content of the given file.

    Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.

    Definition Classes
    FileAndResourceDirectives
  154. def getFromFile(fileName: String)(implicit resolver: ContentTypeResolver): Route

    Completes GET requests with the content of the given file.

    Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.

    Definition Classes
    FileAndResourceDirectives
  155. def getFromResource(resourceName: String, contentType: ContentType, classLoader: ClassLoader = _defaultClassLoader): Route

    Completes GET requests with the content of the given resource.

    Completes GET requests with the content of the given resource. If the resource is a directory or cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  156. def getFromResource(resourceName: String)(implicit resolver: ContentTypeResolver): Route

    Completes GET requests with the content of the given class-path resource.

    Completes GET requests with the content of the given class-path resource. If the resource cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  157. def getFromResourceDirectory(directoryName: String, classLoader: ClassLoader = _defaultClassLoader)(implicit resolver: ContentTypeResolver): Route

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory".

    Same as "getFromDirectory" except that the file is not fetched from the file system but rather from a "resource directory". If the requested resource is itself a directory or cannot be found or read the Route rejects the request.

    Definition Classes
    FileAndResourceDirectives
  158. def handle(handler: PartialFunction[HttpRequest, Future[HttpResponse]], rejections: Seq[Rejection]): StandardRoute

    Handle the request using an asynchronous partial function.

    Handle the request using an asynchronous partial function.

    This directive can be used to include external components request processing components defined as PartialFunction (like those provided by akka-grpc) into a routing tree defined as routes.

    rejections

    The list of rejections to reject with if the handler is not defined for a request.

    Definition Classes
    RouteDirectives
  159. def handle(handler: PartialFunction[HttpRequest, Future[HttpResponse]]): StandardRoute

    Handle the request using an asynchronous partial function.

    Handle the request using an asynchronous partial function.

    This directive can be used to include external components request processing components defined as PartialFunction (like those provided by akka-grpc) into a routing tree defined as routes.

    When the partial function is not defined for a request, the request is rejected with an empty list of rejections which is equivalent to a "Not Found" rejection.

    Definition Classes
    RouteDirectives
  160. def handle(handler: (HttpRequest) => Future[HttpResponse]): StandardRoute

    Handle the request using a function.

    Handle the request using a function.

    Definition Classes
    RouteDirectives
  161. def handleExceptions(handler: ExceptionHandler): Directive0

    Transforms exceptions thrown during evaluation of its inner route using the given akka.http.scaladsl.server.ExceptionHandler.

    Transforms exceptions thrown during evaluation of its inner route using the given akka.http.scaladsl.server.ExceptionHandler.

    Definition Classes
    ExecutionDirectives
  162. def handleRejections(handler: RejectionHandler): Directive0

    Transforms rejections produced by its inner route using the given akka.http.scaladsl.server.RejectionHandler.

    Transforms rejections produced by its inner route using the given akka.http.scaladsl.server.RejectionHandler.

    Definition Classes
    ExecutionDirectives
  163. def handleSync(handler: PartialFunction[HttpRequest, HttpResponse], rejections: Seq[Rejection]): StandardRoute

    Handle the request using a synchronous partial function.

    Handle the request using a synchronous partial function.

    This directive can be used to include external components request processing components defined as PartialFunction (like those provided by akka-grpc) into a routing tree defined as routes.

    rejections

    The list of rejections to reject with if the handler is not defined for a request.

    Definition Classes
    RouteDirectives
  164. def handleSync(handler: PartialFunction[HttpRequest, HttpResponse]): StandardRoute

    Handle the request using a synchronous partial function.

    Handle the request using a synchronous partial function.

    This directive can be used to include external components request processing components defined as PartialFunction (like those provided by akka-grpc) into a routing tree defined as routes.

    When the partial function is not defined for a request, the request is rejected with an empty list of rejections which is equivalent to a "Not Found" rejection.

    Definition Classes
    RouteDirectives
  165. def handleSync(handler: (HttpRequest) => HttpResponse): StandardRoute

    Handle the request using a function.

    Handle the request using a function.

    Definition Classes
    RouteDirectives
  166. def handleWebSocketMessages(handler: Flow[Message, Message, Any]): Route

    Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.

    Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.

    Definition Classes
    WebSocketDirectives
  167. def handleWebSocketMessagesForOptionalProtocol(handler: Flow[Message, Message, Any], subprotocol: Option[String]): Route

    Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.

    Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.

    If the subprotocol parameter is None any WebSocket request is accepted. If the subprotocol parameter is Some(protocol) a WebSocket request is only accepted if the list of subprotocols supported by the client (as announced in the WebSocket request) contains protocol. If the client did not offer the protocol in question the request is rejected with an UnsupportedWebSocketSubprotocolRejection rejection.

    To support several subprotocols you may chain several handleWebSocketMessagesForOptionalProtocol routes.

    Definition Classes
    WebSocketDirectives
  168. def handleWebSocketMessagesForProtocol(handler: Flow[Message, Message, Any], subprotocol: String): Route

    Handles WebSocket requests with the given handler if the given subprotocol is offered in the request and rejects other requests with an ExpectedWebSocketRequestRejection or an UnsupportedWebSocketSubprotocolRejection.

    Handles WebSocket requests with the given handler if the given subprotocol is offered in the request and rejects other requests with an ExpectedWebSocketRequestRejection or an UnsupportedWebSocketSubprotocolRejection.

    Definition Classes
    WebSocketDirectives
  169. def handleWith[A, B](f: (A) => B)(implicit um: FromRequestUnmarshaller[A], m: ToResponseMarshaller[B]): Route

    Completes the request using the given function.

    Completes the request using the given function. The input to the function is produced with the in-scope entity unmarshaller and the result value of the function is marshalled with the in-scope marshaller.

    Definition Classes
    MarshallingDirectives
  170. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  171. def head: Directive0

    Rejects all non-HEAD requests.

    Rejects all non-HEAD requests.

    Definition Classes
    MethodDirectives
  172. def headerValue[T](f: (HttpHeader) => Option[T]): Directive1[T]

    Extracts an HTTP header value using the given function.

    Extracts an HTTP header value using the given function. If the function result is undefined for all headers the request is rejected with an empty rejection set. If the given function throws an exception the request is rejected with a akka.http.scaladsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  173. def headerValueByName(headerName: String): Directive1[String]

    Extracts the value of the HTTP request header with the given name.

    Extracts the value of the HTTP request header with the given name. If no header with a matching name is found the request is rejected with a akka.http.scaladsl.server.MissingHeaderRejection.

    Definition Classes
    HeaderDirectives
  174. def headerValueByType[T](magnet: HeaderMagnet[T]): Directive1[T]

    Extracts the first HTTP request header of the given type.

    Extracts the first HTTP request header of the given type. If no header with a matching type is found the request is rejected with a akka.http.scaladsl.server.MissingHeaderRejection.

    Custom headers will only be matched by this directive if they extend ModeledCustomHeader and provide a companion extending ModeledCustomHeaderCompanion.

    Definition Classes
    HeaderDirectives
  175. def headerValuePF[T](pf: PartialFunction[HttpHeader, T]): Directive1[T]

    Extracts an HTTP header value using the given partial function.

    Extracts an HTTP header value using the given partial function. If the function is undefined for all headers the request is rejected with an empty rejection set.

    Definition Classes
    HeaderDirectives
  176. def host(regex: Regex): Directive1[String]

    Rejects all requests with a host name that doesn't have a prefix matching the given regular expression.

    Rejects all requests with a host name that doesn't have a prefix matching the given regular expression. For all matching requests the prefix string matching the regex is extracted and passed to the inner route. If the regex contains a capturing group only the string matched by this group is extracted. If the regex contains more than one capturing group an IllegalArgumentException is thrown.

    Definition Classes
    HostDirectives
  177. def host(predicate: (String) => Boolean): Directive0

    Rejects all requests for whose host name the given predicate function returns false.

    Rejects all requests for whose host name the given predicate function returns false.

    Definition Classes
    HostDirectives
  178. def host(hostNames: String*): Directive0

    Rejects all requests with a host name different from the given ones.

    Rejects all requests with a host name different from the given ones.

    Definition Classes
    HostDirectives
  179. def ignoreTrailingSlash: Directive0

    Tries to match the inner route and if it fails with an empty rejection, it tries it again adding (or removing) the trailing slash on the given path.

    Tries to match the inner route and if it fails with an empty rejection, it tries it again adding (or removing) the trailing slash on the given path.

    Definition Classes
    PathDirectives
  180. def instanceOf[T](implicit m: ToResponseMarshaller[T]): ToResponseMarshaller[T]

    Returns the in-scope Marshaller for the given type.

    Returns the in-scope Marshaller for the given type.

    Definition Classes
    MarshallingDirectives
  181. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  182. def listDirectoryContents(directories: String*)(implicit renderer: DirectoryRenderer): Route

    Completes GET requests with a unified listing of the contents of all given directories.

    Completes GET requests with a unified listing of the contents of all given directories. The actual rendering of the directory contents is performed by the in-scope Marshaller[DirectoryListing].

    Definition Classes
    FileAndResourceDirectives
  183. def logRequest(magnet: LoggingMagnet[(HttpRequest) => Unit]): Directive0

    Produces a log entry for every incoming request.

    Produces a log entry for every incoming request.

    Definition Classes
    DebuggingDirectives
  184. def logRequestResult(magnet: LoggingMagnet[(HttpRequest) => (RouteResult) => Unit]): Directive0

    Produces a log entry for every incoming request and RouteResult.

    Produces a log entry for every incoming request and RouteResult.

    Definition Classes
    DebuggingDirectives
  185. def logResult(magnet: LoggingMagnet[(RouteResult) => Unit]): Directive0

    Produces a log entry for every RouteResult.

    Produces a log entry for every RouteResult.

    Definition Classes
    DebuggingDirectives
  186. def mapInnerRoute(f: (Route) => Route): Directive0

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    BasicDirectives
  198. 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
  199. 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
  200. def method(httpMethod: HttpMethod): Directive0

    Rejects all requests whose HTTP method does not match the given one.

    Rejects all requests whose HTTP method does not match the given one.

    Definition Classes
    MethodDirectives
  201. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  202. def not(self: PathMatcher[_]): PathMatcher0
    Definition Classes
    PathMatchers
  203. def nothingMatcher[L](implicit arg0: Tuple[L]): PathMatcher[L]

    A PathMatcher that never matches anything.

    A PathMatcher that never matches anything.

    Definition Classes
    PathMatchers
  204. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  205. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  206. def onComplete[T](future: => Future[T]): Directive1[Try[T]]

    "Unwraps" a Future[T] and runs the inner route after future completion with the future's value as an extraction of type Try[T].

    "Unwraps" a Future[T] and runs the inner route after future completion with the future's value as an extraction of type Try[T].

    Definition Classes
    FutureDirectives
  207. def onCompleteWithBreaker[T](breaker: CircuitBreaker)(future: => Future[T]): Directive1[Try[T]]

    "Unwraps" a Future[T] and runs the inner route after future completion with the future's value as an extraction of type T if the supplied CircuitBreaker is closed.

    "Unwraps" a Future[T] and runs the inner route after future completion with the future's value as an extraction of type T if the supplied CircuitBreaker is closed.

    If the supplied CircuitBreaker is open the request is rejected with a CircuitBreakerOpenRejection.

    Definition Classes
    FutureDirectives
  208. def onSuccess(magnet: OnSuccessMagnet): Directive[Out]

    "Unwraps" a Future[T] and runs the inner route after future completion with the future's value as an extraction of type T.

    "Unwraps" a Future[T] and runs the inner route after future completion with the future's value as an extraction of type T. If the future fails its failure Throwable is bubbled up to the nearest ExceptionHandler. If type T is already a Tuple it is directly expanded into the respective number of extractions.

    Definition Classes
    FutureDirectives
  209. def optionalAttribute[T](key: AttributeKey[T]): Directive1[Option[T]]

    Extracts an optional request attribute for the given key.

    Extracts an optional request attribute for the given key.

    Definition Classes
    AttributeDirectives
  210. def optionalCookie(name: String): Directive1[Option[HttpCookiePair]]

    Extracts the HttpCookiePair with the given name as an Option[HttpCookiePair].

    Extracts the HttpCookiePair with the given name as an Option[HttpCookiePair]. If the cookie is not present a value of None is extracted.

    Definition Classes
    CookieDirectives
  211. def optionalHeaderValue[T](f: (HttpHeader) => Option[T]): Directive1[Option[T]]

    Extracts an optional HTTP header value using the given function.

    Extracts an optional HTTP header value using the given function. If the given function throws an exception the request is rejected with a akka.http.scaladsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  212. def optionalHeaderValueByName(headerName: String): Directive1[Option[String]]

    Extracts the value of the optional HTTP request header with the given name.

    Extracts the value of the optional HTTP request header with the given name.

    Definition Classes
    HeaderDirectives
  213. def optionalHeaderValueByType[T <: HttpHeader](magnet: HeaderMagnet[T]): Directive1[Option[T]]

    Extract the header value of the optional HTTP request header with the given type.

    Extract the header value of the optional HTTP request header with the given type.

    Custom headers will only be matched by this directive if they extend ModeledCustomHeader and provide a companion extending ModeledCustomHeaderCompanion.

    Definition Classes
    HeaderDirectives
  214. def optionalHeaderValuePF[T](pf: PartialFunction[HttpHeader, T]): Directive1[Option[T]]

    Extracts an optional HTTP header value using the given partial function.

    Extracts an optional HTTP header value using the given partial function. If the given function throws an exception the request is rejected with a akka.http.scaladsl.server.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  215. def options: Directive0

    Rejects all non-OPTIONS requests.

    Rejects all non-OPTIONS requests.

    Definition Classes
    MethodDirectives
  216. def overrideMethodWithParameter(paramName: String): Directive0

    Changes the HTTP method of the request to the value of the specified query string parameter.

    Changes the HTTP method of the request to the value of the specified query string parameter. If the query string parameter is not specified this directive has no effect. If the query string is specified as something that is not a HTTP method, then this directive completes the request with a 501 Not Implemented response.

    This directive is useful for:

    • Use in combination with JSONP (JSONP only supports GET)
    • Supporting older browsers that lack support for certain HTTP methods. E.g. IE8 does not support PATCH
    Definition Classes
    MethodDirectives
  217. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec, pdef15: ParamSpec, pdef16: ParamSpec, pdef17: ParamSpec, pdef18: ParamSpec, pdef19: ParamSpec, pdef20: ParamSpec, pdef21: ParamSpec, pdef22: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  218. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec, pdef15: ParamSpec, pdef16: ParamSpec, pdef17: ParamSpec, pdef18: ParamSpec, pdef19: ParamSpec, pdef20: ParamSpec, pdef21: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  219. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec, pdef15: ParamSpec, pdef16: ParamSpec, pdef17: ParamSpec, pdef18: ParamSpec, pdef19: ParamSpec, pdef20: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  220. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec, pdef15: ParamSpec, pdef16: ParamSpec, pdef17: ParamSpec, pdef18: ParamSpec, pdef19: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  221. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec, pdef15: ParamSpec, pdef16: ParamSpec, pdef17: ParamSpec, pdef18: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  222. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec, pdef15: ParamSpec, pdef16: ParamSpec, pdef17: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  223. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec, pdef15: ParamSpec, pdef16: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  224. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec, pdef15: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  225. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec, pdef14: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  226. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec, pdef13: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  227. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec, pdef12: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  228. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec, pdef11: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  229. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec, pdef10: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  230. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec, pdef9: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  231. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec, pdef8: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  232. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  233. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec): Directive[(Out, Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  234. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec): Directive[(Out, Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  235. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec): Directive[(Out, Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  236. def parameter(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec): Directive[(Out, Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  237. def parameter(pdef1: ParamSpec, pdef2: ParamSpec): Directive[(Out, Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  238. def parameter(pdef1: ParamSpec): Directive[(Out)]

    Extracts query parameter values from the request.

    Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

    Definition Classes
    ParameterDirectivesInstances
  239. def parameterMap: Directive1[Map[String, String]]

    Extracts the request's query parameters as a Map[String, String].

    Extracts the request's query parameters as a Map[String, String].

    Definition Classes
    ParameterDirectives
  240. def parameterMultiMap: Directive1[Map[String, List[String]]]

    Extracts the request's query parameters as a Map[String, List[String]].

    Extracts the request's query parameters as a Map[String, List[String]].

    Definition Classes
    ParameterDirectives
  241. def parameterSeq: Directive1[Seq[(String, String)]]

    Extracts the request's query parameters as a Seq[(String, String)].

    Extracts the request's query parameters as a Seq[(String, String)].

    Definition Classes
    ParameterDirectives
  242. def parameters(pdef1: ParamSpec, pdef2: ParamSpec, pdef3: ParamSpec, pdef4: ParamSpec, pdef5: ParamSpec, pdef6: ParamSpec, pdef7: