Collects all default directives into one object for simple importing.
Attributes
- Companion
- trait
- Source
- Directives.scala
- Graph
-
- Supertypes
-
trait Directivestrait Http4sDirectivestrait AttributeDirectivestrait WebSocketDirectivestrait SecurityDirectivestrait SchemeDirectivestrait RouteDirectivestrait RespondWithDirectivestrait RangeDirectivestrait PathDirectivestrait PathMatcherstrait TimeoutDirectivestrait ParameterDirectivestrait MiscDirectivestrait MethodDirectivestrait MarshallingDirectivestrait HostDirectivestrait HeaderDirectivestrait IODirectivestrait FormFieldDirectivestrait FileUploadDirectivestrait ExecutionDirectivestrait CodingDirectivestrait DebuggingDirectivestrait CookieDirectivestrait CacheConditionDirectivestrait BasicDirectivestrait RouteConcatenationclass Objecttrait Matchableclass AnyShow all
- Self type
-
Directives.type
Members list
Type members
Inherited classlikes
A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Int value. The matcher will not match 0 digits or a sequence of digits that would represent an Int value larger than Int.MaxValue.
A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Int value. The matcher will not match 0 digits or a sequence of digits that would represent an Int value larger than Int.MaxValue.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Long value. The matcher will not match 0 digits or a sequence of digits that would represent an Long value larger than Long.MaxValue.
A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Long value. The matcher will not match 0 digits or a sequence of digits that would represent an Long value larger than Long.MaxValue.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Int value. The matcher will not match 0 digits or a sequence of digits that would represent an Int value larger than Int.MaxValue.
A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Int value. The matcher will not match 0 digits or a sequence of digits that would represent an Int value larger than Int.MaxValue.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Long value. The matcher will not match 0 digits or a sequence of digits that would represent an Long value larger than Long.MaxValue.
A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Long value. The matcher will not match 0 digits or a sequence of digits that would represent an Long value larger than Long.MaxValue.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
- Supertypes
-
class Objecttrait Matchableclass Any
A PathMatcher that matches the very end of the requests URI path.
A PathMatcher that matches the very end of the requests URI path.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path as an (encoded!) String. If you need access to the remaining unencoded elements of the path use the RemainingPath matcher!
A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path as an (encoded!) String. If you need access to the remaining unencoded elements of the path use the RemainingPath matcher!
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path.
A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
Attributes
- Inherited from:
- RouteConcatenation
- Source
- RouteConcatenation.scala
- Supertypes
-
class Objecttrait Matchableclass Any
A PathMatcher that matches if the unmatched path starts with a path segment. If so the path segment is extracted as a String.
A PathMatcher that matches if the unmatched path starts with a path segment. If so the path segment is extracted as a String.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
A PathMatcher that matches a single slash character ('/').
A PathMatcher that matches a single slash character ('/').
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
Inherited and Abstract classlikes
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Inherited types
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Value members
Inherited methods
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.
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.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
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.
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.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
Returns the in-scope EntityDecoder for the given type.
Returns the in-scope EntityDecoder for the given type.
Attributes
- Inherited from:
- MarshallingDirectives
- Source
- MarshallingDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Lifts an authenticator function into a directive. Same as authenticateOrRejectWithChallenge but only applies the authenticator function with a certain type of credentials.
Lifts an authenticator function into a directive. Same as authenticateOrRejectWithChallenge but only applies the authenticator function with a certain type of credentials.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
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.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.
Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.
Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Asynchronous version of authorize. If the IO fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.
Asynchronous version of authorize. If the IO fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Asynchronous version of authorize. If the IO fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.
Asynchronous version of authorize. If the IO fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
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.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Completes the request using the given arguments.
Completes the request using the given arguments.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given arguments.
Completes the request using the given arguments.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Completes the request using the given arguments.
Completes the request using the given arguments.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
"Unwraps" a IO[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.)
"Unwraps" a IO[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.)
Attributes
- Inherited from:
- IODirectives
- Source
- IODirectives.scala
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.
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.
Value parameters
- routes
-
subroutes to concatenate
Attributes
- Returns
-
the concatenated route
- Inherited from:
- RouteConcatenation
- Source
- RouteConcatenation.scala
Extracts the RequestCookie with the given name. If the cookie is not present the request is rejected with a respective MissingCookieRejection.
Extracts the RequestCookie with the given name. If the cookie is not present the request is rejected with a respective MissingCookieRejection.
Attributes
- Inherited from:
- CookieDirectives
- Source
- CookieDirectives.scala
Rejects all non-DELETE requests.
Rejects all non-DELETE requests.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
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.
Attributes
- Inherited from:
- CookieDirectives
- Source
- CookieDirectives.scala
Adds a Set-Cookie response header expiring the given cookies.
Adds a Set-Cookie response header expiring the given cookies.
Attributes
- Inherited from:
- CookieDirectives
- Source
- CookieDirectives.scala
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.
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.
Attributes
- Inherited from:
- MarshallingDirectives
- Source
- MarshallingDirectives.scala
Extracts a single value using the given function.
Extracts a single value using the given function.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or the TCP connection the request was received from (in that order of priority).
Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or the TCP connection the request was received from (in that order of priority).
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.scala
Extracts the potentially present Credentials provided with the request's Authorization header.
Extracts the potentially present Credentials provided with the request's Authorization header.
Attributes
- Inherited from:
- SecurityDirectives
- Source
- SecurityDirectives.scala
Extracts the entities dataBytes fs2.Stream from the RequestContext.
Extracts the entities dataBytes fs2.Stream from the RequestContext.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the hostname part of the Host request header value.
Extracts the hostname part of the Host request header value.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
Extracts the already matched path from the RequestContext.
Extracts the already matched path from the RequestContext.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the request method.
Extracts the request method.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Extracts the current Request instance.
Extracts the current Request instance.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the RequestContext itself.
Extracts the RequestContext itself.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the EntityBody from the RequestContext.
Extracts the EntityBody from the RequestContext.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the Uri scheme from the request.
Extracts the Uri scheme from the request.
Attributes
- Inherited from:
- SchemeDirectives
- Source
- SchemeDirectives.scala
Extracts the yet unmatched path from the RequestContext.
Extracts the yet unmatched path from the RequestContext.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Extracts the complete request URI.
Extracts the complete request URI.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
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.
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.
Attributes
- Inherited from:
- FileUploadDirectives
- Source
- FileUploadDirectives.scala
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.
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.
Attributes
- Inherited from:
- FileUploadDirectives
- Source
- FileUploadDirectives.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts HTTP form fields from the request as a Map[String, String].
Extracts HTTP form fields from the request as a Map[String, String].
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
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]].
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
Extracts HTTP form fields from the request as a Seq[(String, String)].
Extracts HTTP form fields from the request as a Seq[(String, String)].
Attributes
- Inherited from:
- FormFieldDirectives
- Source
- FormFieldDirectives.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- FormFieldDirectivesInstances
- Source
- FormFieldDirectivesInstances.scala
Rejects all non-GET requests.
Rejects all non-GET requests.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Completes GET requests with the content of a file underneath the given directory. If the file cannot be read the Route rejects the request.
Completes GET requests with the content of a file underneath the given directory. If the file cannot be read the Route rejects the request.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.
Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.
Completes GET requests with the content of the given file. If the file cannot be found or read the request is rejected.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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.
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.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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.
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.
Attributes
- Inherited from:
- FileAndResourceDirectives
- Source
- FileAndResourceDirectives.scala
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.
Value parameters
- rejections
-
The list of rejections to reject with if the handler is not defined for a request.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
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.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Handle the request using a function.
Handle the request using a function.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Transforms exceptions thrown during evaluation of its inner route using the given pl.iterators.stir.server.ExceptionHandler.
Transforms exceptions thrown during evaluation of its inner route using the given pl.iterators.stir.server.ExceptionHandler.
Attributes
- Inherited from:
- ExecutionDirectives
- Source
- ExecutionDirectives.scala
Transforms rejections produced by its inner route using the given pl.iterators.stir.server.RejectionHandler.
Transforms rejections produced by its inner route using the given pl.iterators.stir.server.RejectionHandler.
Attributes
- Inherited from:
- ExecutionDirectives
- Source
- ExecutionDirectives.scala
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.
Value parameters
- rejections
-
The list of rejections to reject with if the handler is not defined for a request.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
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.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Handle the request using a function.
Handle the request using a function.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Handles WebSocket requests with the given handlers and responses to other requests with an org.http4s.Status.NotImplemented status code.
Handles WebSocket requests with the given handlers and responses to other requests with an org.http4s.Status.NotImplemented status code.
Attributes
- Inherited from:
- WebSocketDirectives
- Source
- WebSocketDirectives.scala
Handles WebSocket requests with the given handler and responses to other requests with an org.http4s.Status.NotImplemented status code.
Handles WebSocket requests with the given handler and responses to other requests with an org.http4s.Status.NotImplemented status code.
Attributes
- Inherited from:
- WebSocketDirectives
- Source
- WebSocketDirectives.scala
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.
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.
Attributes
- Inherited from:
- MarshallingDirectives
- Source
- MarshallingDirectives.scala
Rejects all non-HEAD requests.
Rejects all non-HEAD requests.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
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 pl.iterators.stir.server.MalformedHeaderRejection.
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 pl.iterators.stir.server.MalformedHeaderRejection.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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 pl.iterators.stir.server.MissingHeaderRejection.
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 pl.iterators.stir.server.MissingHeaderRejection.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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 MissingHeaderRejection.
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 MissingHeaderRejection.
Custom headers will only be matched by this directive if ev Header.Select[T] is provided.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
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.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
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.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
Rejects all requests with a host name different from the given ones.
Rejects all requests with a host name different from the given ones.
Attributes
- Inherited from:
- HostDirectives
- Source
- HostDirectives.scala
Attributes
- Inherited from:
- Http4sDirectives
- Source
- Http4sDirectives.scala
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.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Returns the in-scope Marshaller for the given type.
Returns the in-scope Marshaller for the given type.
Attributes
- Inherited from:
- MarshallingDirectives
- Source
- MarshallingDirectives.scala
Produces a log entry for every incoming request.
Produces a log entry for every incoming request.
Attributes
- Inherited from:
- DebuggingDirectives
- Source
- DebuggingDirectives.scala
Produces a log entry for every incoming request and RouteResult.
Produces a log entry for every incoming request and RouteResult.
Attributes
- Inherited from:
- DebuggingDirectives
- Source
- DebuggingDirectives.scala
Produces a log entry for every RouteResult.
Produces a log entry for every RouteResult.
Attributes
- Inherited from:
- DebuggingDirectives
- Source
- DebuggingDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Transforms the unmatchedPath of the RequestContext using the given function.
Transforms the unmatchedPath of the RequestContext using the given function.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Rejects all requests whose HTTP method does not match the given one.
Rejects all requests whose HTTP method does not match the given one.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
A PathMatcher that never matches anything.
A PathMatcher that never matches anything.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
"Unwraps" a IO[T] and runs the inner route after io completion with the io's value as an extraction of type Try[T].
"Unwraps" a IO[T] and runs the inner route after io completion with the io's value as an extraction of type Try[T].
Attributes
- Inherited from:
- IODirectives
- Source
- IODirectives.scala
"Unwraps" a IO[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.
"Unwraps" a IO[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.
Attributes
- Inherited from:
- IODirectives
- Source
- IODirectives.scala
Extracts the RequestCookie with the given name as an Option[HttpCookiePair]. If the cookie is not present a value of None is extracted.
Extracts the RequestCookie with the given name as an Option[HttpCookiePair]. If the cookie is not present a value of None is extracted.
Attributes
- Inherited from:
- CookieDirectives
- Source
- CookieDirectives.scala
Extracts an optional HTTP header value using the given function. If the given function throws an exception the request is rejected with a pl.iterators.stir.server.MalformedHeaderRejection.
Extracts an optional HTTP header value using the given function. If the given function throws an exception the request is rejected with a pl.iterators.stir.server.MalformedHeaderRejection.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
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 ev Header.Select[T] is provided.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
Extracts an optional HTTP header value using the given partial function. If the given function throws an exception the request is rejected with a pl.iterators.stir.server.MalformedHeaderRejection.
Extracts an optional HTTP header value using the given partial function. If the given function throws an exception the request is rejected with a pl.iterators.stir.server.MalformedHeaderRejection.
Attributes
- Inherited from:
- HeaderDirectives
- Source
- HeaderDirectives.scala
Rejects all non-OPTIONS requests.
Rejects all non-OPTIONS requests.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
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.
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
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts the request's query parameters as a Map[String, String].
Extracts the request's query parameters as a Map[String, String].
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Extracts the request's query parameters as a Map[String, List[String]].
Extracts the request's query parameters as a Map[String, List[String]].
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Extracts the request's query parameters as a Seq[(String, String)].
Extracts the request's query parameters as a Seq[(String, String)].
Attributes
- Inherited from:
- ParameterDirectives
- Source
- ParameterDirectives.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Extracts query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.
Attributes
- Inherited from:
- ParameterDirectivesInstances
- Source
- ParameterDirectivesInstances.scala
A Directive0 that always passes the request on to its inner route (i.e. does nothing with the request or the response).
A Directive0 that always passes the request on to its inner route (i.e. does nothing with the request or the response).
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Rejects all non-PATCH requests.
Rejects all non-PATCH requests.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
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.
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.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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") {
concat(
pathEnd {
// user list ...
},
path(UUID) { userId =>
// user profile ...
}
)
}
}
}
For further information, refer to:
Attributes
- See also
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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.
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.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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.
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.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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!
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!
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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!
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!
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Rejects all non-POST requests.
Rejects all non-POST requests.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
Injects the given value into a directive.
Injects the given value into a directive.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Rejects all non-PUT requests.
Rejects all non-PUT requests.
Attributes
- Inherited from:
- MethodDirectives
- Source
- MethodDirectives.scala
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.
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.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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".
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".
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
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.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
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.
Note, however, that this directive doesn't apply to a URI consisting of just a single slash. HTTP does not support empty target paths, so that browsers will convert a URI such as http://example.org to http://example.org/ adding the trailing slash.
Redirecting the single slash path URI would lead to a redirection loop.
'''Caveat''': pathSingleSlash directive will only match on the root path level inside of this directive.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
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.
Attributes
- Inherited from:
- PathDirectives
- Source
- PathDirectives.scala
Rejects the request with the given rejections.
Rejects the request with the given rejections.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
Rejects the request with an empty set of rejections.
Rejects the request with an empty set of rejections.
Attributes
- Inherited from:
- RouteDirectives
- Source
- RouteDirectives.scala
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.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
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.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
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.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
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.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
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.
Attributes
- Inherited from:
- RespondWithDirectives
- Source
- RespondWithDirectives.scala
Rejects all requests whose Uri scheme does not match the given one.
Rejects all requests whose Uri scheme does not match the given one.
Attributes
- Inherited from:
- SchemeDirectives
- Source
- SchemeDirectives.scala
Inspects the request's Accept-Language header and determines, which of the given language alternatives is preferred by the client. (See http://tools.ietf.org/html/rfc7231#section-5.3.5 for more details on the negotiation logic.) If there are several best language alternatives that the client has equal preference for (even if this preference is zero!) the order of the arguments is used as a tie breaker (First one wins).
Inspects the request's Accept-Language header and determines, which of the given language alternatives is preferred by the client. (See http://tools.ietf.org/html/rfc7231#section-5.3.5 for more details on the negotiation logic.) If there are several best language alternatives that the client has equal preference for (even if this preference is zero!) the order of the arguments is used as a tie breaker (First one wins).
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.scala
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.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
Adds a `Set-Cookie` response header with the given cookies.
Adds a `Set-Cookie` response header with the given cookies.
Attributes
- Inherited from:
- CookieDirectives
- Source
- CookieDirectives.scala
Streams the bytes of the file submitted using multipart with the given file name into a designated file on disk. If there is an error writing to disk the request will be failed with the thrown exception, 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.
Streams the bytes of the file submitted using multipart with the given file name into a designated file on disk. If there is an error writing to disk the request will be failed with the thrown exception, 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.
Attributes
- Inherited from:
- FileUploadDirectives
- Source
- FileUploadDirectives.scala
Streams the bytes of the file submitted using multipart with the given field name into designated files on disk. If there is an error writing to disk the request will be failed with the thrown exception, if there is no such field the request will be rejected. Stored files are cleaned up on exit but not on failure.
Streams the bytes of the file submitted using multipart with the given field name into designated files on disk. If there is an error writing to disk the request will be failed with the thrown exception, if there is no such field the request will be rejected. Stored files are cleaned up on exit but not on failure.
Attributes
- Inherited from:
- FileUploadDirectives
- Source
- FileUploadDirectives.scala
Extracts a number of values using the given function.
Extracts a number of values using the given function.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Injects the given values into a directive.
Injects the given values into a directive.
Attributes
- Inherited from:
- BasicDirectives
- Source
- BasicDirectives.scala
Checks the given condition before running its inner route. If the condition fails the route is rejected with a ValidationRejection.
Checks the given condition before running its inner route. If the condition fails the route is rejected with a ValidationRejection.
Attributes
- Inherited from:
- MiscDirectives
- Source
- MiscDirectives.scala
Tries to set a new request timeout and handler (if provided) at the same time.
Tries to set a new request timeout and handler (if provided) at the same time.
Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!
Value parameters
- handler
-
optional custom "timeout response" function. If left None, the default timeout HttpResponse will be used.
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.scala
Tries to set a new request timeout and handler (if provided) at the same time.
Tries to set a new request timeout and handler (if provided) at the same time.
Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!
Value parameters
- handler
-
optional custom "timeout response" function. If left None, the default timeout Response[IO] will be used.
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.scala
Tries to set a new request timeout and handler (if provided) at the same time.
Tries to set a new request timeout and handler (if provided) at the same time.
Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.scala
Attributes
- Inherited from:
- TimeoutDirectives
- Source
- TimeoutDirectives.scala
Inherited fields
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.
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.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
A PathMatcher that matches and extracts a java.util.UUID instance.
A PathMatcher that matches and extracts a java.util.UUID instance.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
A PathMatcher that always matches, doesn't consume anything and extracts nothing. Serves mainly as a neutral element in PathMatcher composition.
A PathMatcher that always matches, doesn't consume anything and extracts nothing. Serves mainly as a neutral element in PathMatcher composition.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
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.
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.
Attributes
- Inherited from:
- PathMatchers
- Source
- PathMatcher.scala
Implicits
Inherited implicits
Attributes
- Inherited from:
- RouteConcatenation
- Source
- RouteConcatenation.scala
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.
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.
Attributes
- Inherited from:
- ImplicitPathMatcherConstruction
- Source
- PathMatcher.scala
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).
Attributes
- Inherited from:
- ImplicitPathMatcherConstruction
- Source
- PathMatcher.scala
Attributes
- Inherited from:
- ToNameReceptacleEnhancements (hidden)
- Source
- NameReceptacle.scala
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.
Attributes
- Inherited from:
- ImplicitPathMatcherConstruction
- Source
- PathMatcher.scala
Attributes
- Inherited from:
- ImplicitPathMatcherConstruction
- Source
- PathMatcher.scala
Attributes
- Inherited from:
- ToNameReceptacleEnhancements (hidden)
- Source
- NameReceptacle.scala
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.
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.
Attributes
- Inherited from:
- ImplicitPathMatcherConstruction
- Source
- PathMatcher.scala