39 lines
No EOL
1.5 KiB
ReStructuredText
39 lines
No EOL
1.5 KiB
ReStructuredText
.. _-pathSuffixTest-:
|
|
|
|
pathSuffixTest
|
|
==============
|
|
|
|
Checks whether the unmatched path of the ``RequestContext`` has a suffix matched by the given ``PathMatcher``.
|
|
Potentially extracts one or more values (depending on the type of the argument) but doesn't consume its match from
|
|
the unmatched path.
|
|
|
|
|
|
Signature
|
|
---------
|
|
|
|
.. includecode2:: /../../akka-http-scala/src/main/scala/akka/http/scaladsl/server/directives/PathDirectives.scala
|
|
:snippet: pathSuffixTest
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
This directive is very similar to the :ref:`-pathSuffix-` directive with the one difference that the path suffix
|
|
it matched (if it matched) is *not* consumed. The unmatched path of the ``RequestContext`` is therefore left as
|
|
is even in the case that the directive successfully matched and the request is passed on to its inner route.
|
|
|
|
As opposed to :ref:`-pathPrefixTest-` this directive matches and consumes the unmatched path from the right, i.e. the end.
|
|
|
|
.. caution:: 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``! The order within a segment match is
|
|
not reversed.
|
|
|
|
Depending on the type of its ``PathMatcher`` argument the ``pathSuffixTest`` directive extracts zero or more values from
|
|
the URI. If the match fails the request is rejected with an :ref:`empty rejection set <empty rejections>`.
|
|
|
|
|
|
Example
|
|
-------
|
|
|
|
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/PathDirectivesExamplesSpec.scala
|
|
:snippet: pathSuffixTest- |