pekko/akka-docs/rst/scala/http/routing-dsl/directives/basic-directives/textract.rst
2016-01-14 00:31:03 +01:00

30 lines
915 B
ReStructuredText

.. _-textract-:
textract
========
Signature
---------
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/BasicDirectives.scala
:snippet: textract
Description
-----------
Extracts a tuple of values from the request context and provides them to the inner route.
The ``textract`` directive is used as a building block for :ref:`Custom Directives` to extract data from the
``RequestContext`` and provide it to the inner route. To extract just one value use the :ref:`-extract-` directive. To
provide a constant value independent of the ``RequestContext`` use the :ref:`-tprovide-` directive instead.
See :ref:`ProvideDirectives` for an overview of similar directives.
See also :ref:`-extract-` for extracting a single value.
Example
-------
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/BasicDirectivesExamplesSpec.scala
:snippet: textract