akka.http.scaladsl.server

Directives

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

Source
Directives.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Directives
  2. WebsocketDirectives
  3. SecurityDirectives
  4. SchemeDirectives
  5. RouteDirectives
  6. RespondWithDirectives
  7. RangeDirectives
  8. PathDirectives
  9. ImplicitPathMatcherConstruction
  10. PathMatchers
  11. ParameterDirectives
  12. MiscDirectives
  13. MethodDirectives
  14. MarshallingDirectives
  15. HostDirectives
  16. HeaderDirectives
  17. FutureDirectives
  18. FormFieldDirectives
  19. ToNameReceptacleEnhancements
  20. FileAndResourceDirectives
  21. ExecutionDirectives
  22. CodingDirectives
  23. DebuggingDirectives
  24. CookieDirectives
  25. CacheConditionDirectives
  26. BasicDirectives
  27. RouteConcatenation
  28. AnyRef
  29. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type AsyncAuthenticator[T] = (UserCredentials) ⇒ Future[Option[T]]

    Definition Classes
    SecurityDirectives
  2. type AsyncAuthenticatorPF[T] = PartialFunction[UserCredentials, 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] = (UserCredentials) ⇒ Option[T]

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

    Definition Classes
    SecurityDirectives
  6. abstract class NumberMatcher[T] extends PathMatcher1[T]

    Definition Classes
    PathMatchers

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

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

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

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. 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
  9. object HexIntNumber extends NumberMatcher[Int]

    A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Int value.

  10. object HexLongNumber extends NumberMatcher[Long]

    A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Long value.

  11. object IntNumber extends NumberMatcher[Int]

    A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Int value.

  12. val JavaUUID: PathMatcher1[UUID]

    A PathMatcher that matches and extracts a java.

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

    Definition Classes
    PathMatchers
  13. object LongNumber extends NumberMatcher[Long]

    A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Long value.

  14. 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
  15. object PathEnd extends PathMatcher0

    A PathMatcher that matches the very end of the requests URI path.

  16. object Rest extends PathMatcher1[String]

    A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path as an (encoded!) String.

  17. object RestPath extends PathMatcher1[Path]

    A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path.

  18. object Segment extends PathMatcher1[String]

    A PathMatcher that matches if the unmatched path starts with a path segment.

  19. 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
  20. 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
  21. 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
  22. object Slash extends PathMatcher0

    A PathMatcher that matches a single slash character ('/').

  23. 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
  24. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  25. def authenticateBasic[T](realm: String, authenticator: (UserCredentials) ⇒ Option[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
  26. def authenticateBasicAsync[T](realm: String, authenticator: (UserCredentials) ⇒ Future[Option[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
  27. 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
  28. 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
  29. 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
  30. 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
  31. 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
  32. 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
  33. 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
  34. 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
  35. 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
  36. def challengeFor(realm: String): HttpChallenge

    Creates a Basic HttpChallenge for the given realm.

    Creates a Basic HttpChallenge for the given realm.

    Definition Classes
    SecurityDirectives
  37. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def complete(m: ⇒ ToResponseMarshallable): StandardRoute

    Completes the request using the given arguments.

    Completes the request using the given arguments.

    Definition Classes
    RouteDirectives
  39. 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
  40. def completeWith[T](marshaller: ToResponseMarshaller[T])(inner: ((T) ⇒ Unit) ⇒ Unit): (RequestContext) ⇒ Future[RouteResult]

    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
  41. def conditional(eTag: Option[EntityTag], lastModified: Option[DateTime]): Directive0

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

    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
  42. def conditional(eTag: EntityTag, lastModified: DateTime): Directive0

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

    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
  43. def conditional(lastModified: DateTime): Directive0

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

    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
  44. def conditional(eTag: EntityTag): Directive0

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

    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
  45. 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
  46. 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
  47. 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
  48. 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
  49. def defaultClassLoader: ClassLoader

    Attributes
    protected[akka.http]
    Definition Classes
    FileAndResourceDirectives
  50. def delete: Directive0

    Rejects all non-DELETE requests.

    Rejects all non-DELETE requests.

    Definition Classes
    MethodDirectives
  51. 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
  52. 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
  53. 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
  54. 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
  55. implicit def enhanceRouteWithConcatenation(route: (RequestContext) ⇒ Future[RouteResult]): RouteWithConcatenation

    Definition Classes
    RouteConcatenation
  56. def ensuring(cond: (Directives) ⇒ Boolean, msg: ⇒ Any): Directives

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

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

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

    Implicit information
    This member is added by an implicit conversion from Directives to Ensuring[Directives] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  60. 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
  61. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  63. 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
  64. def extractClientIP: Directive1[RemoteAddress]

    Extracts the client's IP from either the X-Forwarded-For, Remote-Address or X-Real-IP header (in that order of priority).

    Extracts the client's IP from either the X-Forwarded-For, Remote-Address or X-Real-IP header (in that order of priority).

    Definition Classes
    MiscDirectives
  65. 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
  66. def extractExecutionContext: Directive1[ExecutionContext]

    Extracts the ExecutionContext from the RequestContext.

    Extracts the ExecutionContext from the RequestContext.

    Definition Classes
    BasicDirectives
  67. 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
  68. def extractLog: Directive1[LoggingAdapter]

    Extracts the LoggingAdapter from the RequestContext.

    Extracts the LoggingAdapter from the RequestContext.

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

    Extracts the Materializer from the RequestContext.

    Extracts the Materializer from the RequestContext.

    Definition Classes
    BasicDirectives
  70. def extractMethod: Directive1[HttpMethod]

    Extracts the request method.

    Extracts the request method.

    Definition Classes
    MethodDirectives
  71. def extractRequest: Directive1[HttpRequest]

    Extracts the current HttpRequest instance.

    Extracts the current HttpRequest instance.

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

    Extracts the RequestContext itself.

    Extracts the RequestContext itself.

    Definition Classes
    BasicDirectives
  73. def extractScheme: Directive1[String]

    Extracts the Uri scheme from the request.

    Extracts the Uri scheme from the request.

    Definition Classes
    SchemeDirectives
  74. def extractSettings: Directive1[RoutingSettings]

    Extracts the RoutingSettings from the RequestContext.

    Extracts the RoutingSettings from the RequestContext.

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

    Extracts the yet unmatched path from the RequestContext.

    Extracts the yet unmatched path from the RequestContext.

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

    Extracts the complete request URI.

    Extracts the complete request URI.

    Definition Classes
    BasicDirectives
  77. 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
  78. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  79. def formField(pdm: FieldMagnet): Out

    Extracts an HTTP form field from the request.

    Extracts an HTTP form field from the request. Rejects the request if the defined form field matcher(s) don't match.

    Definition Classes
    FormFieldDirectives
  80. def formFields(pdm: FieldMagnet): Out

    Extracts a number of HTTP form field from the request.

    Extracts a number of HTTP form field from the request. Rejects the request if the defined form field matcher(s) don't match.

    Definition Classes
    FormFieldDirectives
  81. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Directives to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  82. def get: Directive0

    Rejects all non-GET requests.

    Rejects all non-GET requests.

    Definition Classes
    MethodDirectives
  83. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  84. def getFromBrowseableDirectories(directories: String*)(implicit renderer: DirectoryRenderer, resolver: ContentTypeResolver): (RequestContext) ⇒ Future[RouteResult]

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

    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
  85. def getFromBrowseableDirectory(directory: String)(implicit renderer: DirectoryRenderer, resolver: ContentTypeResolver): (RequestContext) ⇒ Future[RouteResult]

    Same as getFromBrowseableDirectories with only one directory.

    Same as getFromBrowseableDirectories with only one directory.

    Definition Classes
    FileAndResourceDirectives
  86. def getFromDirectory(directoryName: String)(implicit resolver: ContentTypeResolver): (RequestContext) ⇒ Future[RouteResult]

    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
  87. def getFromFile(file: File, contentType: ContentType): (RequestContext) ⇒ Future[RouteResult]

    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
  88. def getFromFile(file: File)(implicit resolver: ContentTypeResolver): (RequestContext) ⇒ Future[RouteResult]

    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
  89. def getFromFile(fileName: String)(implicit resolver: ContentTypeResolver): (RequestContext) ⇒ Future[RouteResult]

    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
  90. def getFromResource(resourceName: String, contentType: ContentType, classLoader: ClassLoader = defaultClassLoader): (RequestContext) ⇒ Future[RouteResult]

    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
  91. def getFromResource(resourceName: String)(implicit resolver: ContentTypeResolver): (RequestContext) ⇒ Future[RouteResult]

    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
  92. def getFromResourceDirectory(directoryName: String, classLoader: ClassLoader = defaultClassLoader)(implicit resolver: ContentTypeResolver): (RequestContext) ⇒ Future[RouteResult]

    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
  93. 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
  94. 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
  95. def handleWebsocketMessages(handler: Flow[Message, Message, Any]): (RequestContext) ⇒ Future[RouteResult]

    Handles websocket requests with the given handler and rejects other requests with a ExpectedWebsocketRequestRejection.

    Handles websocket requests with the given handler and rejects other requests with a ExpectedWebsocketRequestRejection.

    Definition Classes
    WebsocketDirectives
  96. def handleWith[A, B](f: (A) ⇒ B)(implicit um: FromRequestUnmarshaller[A], m: ToResponseMarshaller[B]): (RequestContext) ⇒ Future[RouteResult]

    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
  97. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  98. def head: Directive0

    Rejects all non-HEAD requests.

    Rejects all non-HEAD requests.

    Definition Classes
    MethodDirectives
  99. 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 spray.routing.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  100. 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 spray.routing.MissingHeaderRejection.

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

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

    Extracts the value of the first HTTP request header with the given name. If no header with a matching name is found the request is rejected with a spray.routing.MissingHeaderRejection.

    Definition Classes
    HeaderDirectives
  102. def headerValueByType[T <: HttpHeader](magnet: ClassMagnet[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 spray.routing.MissingHeaderRejection.

    Definition Classes
    HeaderDirectives
  103. 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
  104. 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
  105. 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
  106. 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
  107. 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
  108. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  109. def listDirectoryContents(directories: String*)(implicit renderer: DirectoryRenderer): (RequestContext) ⇒ Future[RouteResult]

    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
  110. 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
  111. 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
  112. def logResult(magnet: LoggingMagnet[(RouteResult) ⇒ Unit]): Directive0

    Produces a log entry for every RouteResult.

    Produces a log entry for every RouteResult.

    Definition Classes
    DebuggingDirectives
  113. def mapInnerRoute(f: ((RequestContext) ⇒ Future[RouteResult]) ⇒ (RequestContext) ⇒ Future[RouteResult]): Directive0

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    BasicDirectives
  125. 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
  126. 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
  127. 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
  128. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  129. def nothingMatcher[L](implicit arg0: Tuple[L]): PathMatcher[L]

    A PathMatcher that never matches anything.

    A PathMatcher that never matches anything.

    Definition Classes
    PathMatchers
  130. final def notify(): Unit

    Definition Classes
    AnyRef
  131. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  132. 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
  133. 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
  134. 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
  135. 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 spray.routing.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  136. 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
  137. def optionalHeaderValueByName(headerName: Symbol): 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
  138. def optionalHeaderValueByType[T <: HttpHeader](magnet: ClassMagnet[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.

    Definition Classes
    HeaderDirectives
  139. 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 spray.routing.MalformedHeaderRejection.

    Definition Classes
    HeaderDirectives
  140. def options: Directive0

    Rejects all non-OPTIONS requests.

    Rejects all non-OPTIONS requests.

    Definition Classes
    MethodDirectives
  141. 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
  142. def overrideStatusCode(responseStatus: StatusCode): Directive0

    Overrides the response status code with the given one.

    Overrides the response status code with the given one.

    Definition Classes
    RespondWithDirectives
  143. def parameter(pdm: ParamMagnet): Out

    Extracts a query parameter value from the request.

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

    Definition Classes
    ParameterDirectives
  144. 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
  145. 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
  146. 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
  147. def parameters(pdm: ParamMagnet): Out

    Extracts a number of query parameter values from the request.

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

    Definition Classes
    ParameterDirectives
  148. def pass: Directive0

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

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

    Definition Classes
    BasicDirectives
  149. def patch: Directive0

    Rejects all non-PATCH requests.

    Rejects all non-PATCH requests.

    Definition Classes
    MethodDirectives
  150. def path[L](pm: PathMatcher[L]): Directive[L]

    Applies the given PathMatcher to the remaining unmatched path after consuming a leading slash.

    Applies the given PathMatcher to the remaining unmatched path after consuming a leading slash. The matcher has to match the remaining path completely. If matched the value extracted by the PathMatcher is extracted on the directive level.

    Definition Classes
    PathDirectives
  151. def pathEnd: Directive0

    Rejects the request if the unmatchedPath of the RequestContext is non-empty, or said differently: only passes on the request to its inner route if the request path has been matched completely.

    Rejects the request if the unmatchedPath of the RequestContext is non-empty, or said differently: only passes on the request to its inner route if the request path has been matched completely.

    Definition Classes
    PathDirectives
  152. def pathEndOrSingleSlash: Directive0

    Only passes on the request to its inner route if the request path has been matched completely or only consists of exactly one remaining slash.

    Only passes on the request to its inner route if the request path has been matched completely or only consists of exactly one remaining slash.

    Note that trailing slash and non-trailing slash URLs are not the same, although they often serve the same content. It is recommended to serve only one URL version and make the other redirect to it using redirectToTrailingSlashIfMissing or redirectToNoTrailingSlashIfPresent directive.

    For example:

    def route = {
    // redirect '/users/' to '/users', '/users/:userId/' to '/users/:userId'
    redirectToNoTrailingSlashIfPresent(Found) {
      pathPrefix("users") {
        pathEnd {
          // user list ...
        } ~
        path(UUID) { userId =>
          // user profile ...
        }
      }
    }
    }

    For further information, refer to: http://googlewebmastercentral.blogspot.de/2010/04/to-slash-or-not-to-slash.html

    Definition Classes
    PathDirectives
  153. def pathPrefix[L](pm: PathMatcher[L]): Directive[L]

    Applies the given PathMatcher to a prefix of the remaining unmatched path after consuming a leading slash.

    Applies the given PathMatcher to a prefix of the remaining unmatched path after consuming a leading slash. The matcher has to match a prefix of the remaining path. If matched the value extracted by the PathMatcher is extracted on the directive level.

    Definition Classes
    PathDirectives
  154. def pathPrefixTest[L](pm: PathMatcher[L]): Directive[L]

    Checks whether the unmatchedPath of the RequestContext has a prefix matched by the given PathMatcher.

    Checks whether the unmatchedPath of the RequestContext has a prefix matched by the given PathMatcher. In analogy to the pathPrefix directive a leading slash is implied.

    Definition Classes
    PathDirectives
  155. def pathSingleSlash: Directive0

    Only passes on the request to its inner route if the request path consists of exactly one remaining slash.

    Only passes on the request to its inner route if the request path consists of exactly one remaining slash.

    Definition Classes
    PathDirectives
  156. def pathSuffix[L](pm: PathMatcher[L]): Directive[L]

    Applies the given PathMatcher to a suffix of the remaining unmatchedPath of the RequestContext.

    Applies the given PathMatcher to a suffix of the remaining unmatchedPath of the RequestContext. If matched the value extracted by the PathMatcher is extracted and the matched parts of the path are consumed. Note that, for efficiency reasons, the given PathMatcher must match the desired suffix in reversed-segment order, i.e. pathSuffix("baz" / "bar") would match /foo/bar/baz!

    Definition Classes
    PathDirectives
  157. def pathSuffixTest[L](pm: PathMatcher[L]): Directive[L]

    Checks whether the unmatchedPath of the RequestContext has a suffix matched by the given PathMatcher.

    Checks whether the unmatchedPath of the RequestContext has a suffix matched by the given PathMatcher. However, as opposed to the pathSuffix directive the matched path is not actually "consumed". Note that, for efficiency reasons, the given PathMatcher must match the desired suffix in reversed-segment order, i.e. pathSuffixTest("baz" / "bar") would match /foo/bar/baz!

    Definition Classes
    PathDirectives
  158. def post: Directive0

    Rejects all non-POST requests.

    Rejects all non-POST requests.

    Definition Classes
    MethodDirectives
  159. def provide[T](value: T): Directive1[T]

    Injects the given value into a directive.

    Injects the given value into a directive.

    Definition Classes
    BasicDirectives
  160. def put: Directive0

    Rejects all non-PUT requests.

    Rejects all non-PUT requests.

    Definition Classes
    MethodDirectives
  161. def rawPathPrefix[L](pm: PathMatcher[L]): Directive[L]

    Applies the given matcher directly to a prefix of the unmatched path of the RequestContext (i.

    Applies the given matcher directly to a prefix of the unmatched path of the RequestContext (i.e. without implicitly consuming a leading slash). The matcher has to match a prefix of the remaining path. If matched the value extracted by the PathMatcher is extracted on the directive level.

    Definition Classes
    PathDirectives
  162. def rawPathPrefixTest[L](pm: PathMatcher[L]): Directive[L]

    Checks whether the unmatchedPath of the RequestContext has a prefix matched by the given PathMatcher.

    Checks whether the unmatchedPath of the RequestContext has a prefix matched by the given PathMatcher. However, as opposed to the pathPrefix directive the matched path is not actually "consumed".

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

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

    Definition Classes
    BasicDirectives
  165. def redirect(uri: Uri, redirectionType: Redirection): StandardRoute

    Completes the request with redirection response of the given type to the given URI.

    Completes the request with redirection response of the given type to the given URI.

    Definition Classes
    RouteDirectives
  166. def redirectToNoTrailingSlashIfPresent(redirectionType: Redirection): Directive0

    If the request path ends with a slash, redirect to the same uri without trailing slash in the path.

    If the request path ends with a slash, redirect to the same uri without trailing slash in the path.

    Caveat: pathSingleSlash directive will not match inside of this directive.

    Definition Classes
    PathDirectives
  167. def redirectToTrailingSlashIfMissing(redirectionType: Redirection): Directive0

    If the request path doesn't end with a slash, redirect to the same uri with trailing slash in the path.

    If the request path doesn't end with a slash, redirect to the same uri with trailing slash in the path.

    Caveat: path without trailing slash and pathEnd directives will not match inside of this directive.

    Definition Classes
    PathDirectives
  168. 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
  169. def reject(rejections: Rejection*): StandardRoute

    Rejects the request with the given rejections.

    Rejects the request with the given rejections.

    Definition Classes
    RouteDirectives
  170. def reject: StandardRoute

    Rejects the request with an empty set of rejections.

    Rejects the request with an empty set of rejections.

    Definition Classes
    RouteDirectives
  171. def rejectEmptyResponse: Directive0

    Converts responses with an empty entity into (empty) rejections.

    Converts responses with an empty entity into (empty) rejections. This way you can, for example, have the marshalling of a None option be treated as if the request could not be matched.

    Definition Classes
    MiscDirectives
  172. def requestEncodedWith(encoding: HttpEncoding): Directive0

    Rejects the request with an UnsupportedRequestEncodingRejection if its encoding doesn't match the given one.

    Rejects the request with an UnsupportedRequestEncodingRejection if its encoding doesn't match the given one.

    Definition Classes
    CodingDirectives
  173. def requestEntityEmpty: Directive0

    Rejects if the request entity is non-empty.

    Rejects if the request entity is non-empty.

    Definition Classes
    MiscDirectives
  174. def requestEntityPresent: Directive0

    Rejects with a RequestEntityExpectedRejection if the request entity is empty.

    Rejects with a RequestEntityExpectedRejection if the request entity is empty. Non-empty requests are passed on unchanged to the inner route.

    Definition Classes
    MiscDirectives
  175. def respondWithDefaultHeader(responseHeader: HttpHeader): Directive0

    Adds the given response header to all HTTP responses of its inner Route, if the response from the inner Route doesn't already contain a header with the same name.

    Adds the given response header to all HTTP responses of its inner Route, if the response from the inner Route doesn't already contain a header with the same name.

    Definition Classes
    RespondWithDirectives
  176. def respondWithDefaultHeaders(responseHeaders: Seq[HttpHeader]): Directive0

    Definition Classes
    RespondWithDirectives
  177. def respondWithDefaultHeaders(responseHeaders: HttpHeader*): Directive0

    Adds the given response headers to all HTTP responses of its inner Route, if a header already exists it is not added again.

    Adds the given response headers to all HTTP responses of its inner Route, if a header already exists it is not added again.

    Definition Classes
    RespondWithDirectives
  178. def respondWithHeader(responseHeader: HttpHeader): Directive0

    Unconditionally adds the given response header to all HTTP responses of its inner Route.

    Unconditionally adds the given response header to all HTTP responses of its inner Route.

    Definition Classes
    RespondWithDirectives
  179. def respondWithHeaders(responseHeaders: Seq[HttpHeader]): Directive0

    Unconditionally adds the given response headers to all HTTP responses of its inner Route.

    Unconditionally adds the given response headers to all HTTP responses of its inner Route.

    Definition Classes
    RespondWithDirectives
  180. def respondWithHeaders(responseHeaders: HttpHeader*): Directive0

    Unconditionally adds the given response headers to all HTTP responses of its inner Route.

    Unconditionally adds the given response headers to all HTTP responses of its inner Route.

    Definition Classes
    RespondWithDirectives
  181. def responseEncodingAccepted(encoding: HttpEncoding): Directive0

    Rejects the request with an UnacceptedResponseEncodingRejection if the given response encoding is not accepted by the client.

    Rejects the request with an UnacceptedResponseEncodingRejection if the given response encoding is not accepted by the client.

    Definition Classes
    CodingDirectives
  182. def scheme(name: String): Directive0

    Rejects all requests whose Uri scheme does not match the given one.

    Rejects all requests whose Uri scheme does not match the given one.

    Definition Classes
    SchemeDirectives
  183. 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
  184. def separateOnSlashes(string: String): PathMatcher0

    Converts a path string containing slashes into a PathMatcher that interprets slashes as path segment separators.

    Converts a path string containing slashes into a PathMatcher that interprets slashes as path segment separators.

    Definition Classes
    PathMatchers
  185. def setCookie(first: HttpCookie, more: HttpCookie*): Directive0

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

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

    Definition Classes
    CookieDirectives
  186. implicit def string2NR(string: String): NameReceptacle[String]

    Definition Classes
    ToNameReceptacleEnhancements
  187. 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
  188. implicit def stringNameOptionReceptacle2PathMatcher(nr: NameOptionReceptacle[String]): PathMatcher0

  189. implicit def symbol2NR(symbol: Symbol): NameReceptacle[String]

    Definition Classes
    ToNameReceptacleEnhancements
  190. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Extracts a number of values using the given function.

    Extracts a number of values using the given function.

    Definition Classes
    BasicDirectives
  192. def toString(): String

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

    Injects the given values into a directive.

    Injects the given values into a directive.

    Definition Classes
    BasicDirectives
  194. def validate(check: ⇒ Boolean, errorMsg: String): Directive0

    Checks the given condition before running its inner route.

    Checks the given condition before running its inner route. If the condition fails the route is rejected with a ValidationRejection.

    Definition Classes
    MiscDirectives
  195. 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.

    Definition Classes
    ImplicitPathMatcherConstruction
  196. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  199. def withExecutionContext(ec: ExecutionContext): Directive0

    Runs its inner route with the given alternative ExecutionContext.

    Runs its inner route with the given alternative ExecutionContext.

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

    Runs its inner route with the given alternative LoggingAdapter.

    Runs its inner route with the given alternative LoggingAdapter.

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

    Runs its inner route with the given alternative Materializer.

    Runs its inner route with the given alternative Materializer.

    Definition Classes
    BasicDirectives
  202. def withRangeSupport: Directive0

    Answers GET requests with an Accept-Ranges: bytes header and converts HttpResponses coming back from its inner route into partial responses if the initial request contained a valid Range request header.

    Answers GET requests with an Accept-Ranges: bytes header and converts HttpResponses coming back from its inner route into partial responses if the initial request contained a valid Range request header. The requested byte-ranges may be coalesced. This directive is transparent to non-GET requests Rejects requests with unsatisfiable ranges UnsatisfiableRangeRejection. Rejects requests with too many expected ranges.

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

    Definition Classes
    RangeDirectives
    See also

    https://tools.ietf.org/html/rfc7233

  203. def withSettings(settings: RoutingSettings): Directive0

    Runs its inner route with the given alternative RoutingSettings.

    Runs its inner route with the given alternative RoutingSettings.

    Definition Classes
    BasicDirectives
  204. def [B](y: B): (Directives, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Directives to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (directives: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Directives to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (directives: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Directives

    Implicit information
    This member is added by an implicit conversion from Directives to ArrowAssoc[Directives] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (directives: ArrowAssoc[Directives]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Directives

    Implicit information
    This member is added by an implicit conversion from Directives to Ensuring[Directives] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (directives: Ensuring[Directives]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from WebsocketDirectives

Inherited from SecurityDirectives

Inherited from SchemeDirectives

Inherited from RouteDirectives

Inherited from RespondWithDirectives

Inherited from RangeDirectives

Inherited from PathDirectives

Inherited from PathMatchers

Inherited from ParameterDirectives

Inherited from MiscDirectives

Inherited from MethodDirectives

Inherited from MarshallingDirectives

Inherited from HostDirectives

Inherited from HeaderDirectives

Inherited from FutureDirectives

Inherited from FormFieldDirectives

Inherited from ToNameReceptacleEnhancements

Inherited from FileAndResourceDirectives

Inherited from ExecutionDirectives

Inherited from CodingDirectives

Inherited from DebuggingDirectives

Inherited from CookieDirectives

Inherited from CacheConditionDirectives

Inherited from BasicDirectives

Inherited from RouteConcatenation

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Directives to StringAdd

Inherited by implicit conversion any2stringfmt from Directives to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Directives to ArrowAssoc[Directives]

Inherited by implicit conversion any2Ensuring from Directives to Ensuring[Directives]

Ungrouped