raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

+htp #18496 add missing directive documentation (scala)

Browse source
This commit is contained in:
Konrad Malawski 2015-10-01 13:25:41 +02:00
parent f9909d79ab
commit 7f883a8b16
49 changed files with 1453 additions and 195 deletions
Download patch file Download diff file Expand all files Collapse all files

7
akka-docs-dev/rst/scala/http/routing-dsl/directives/basic-directives/extractLog.rst
View file

@ -3,7 +3,7 @@
extractLog
==========
...
Extracts a :class:`LoggingAdapter` from the request context which can be used for logging inside the route.
Signature
---------
@ -14,7 +14,10 @@ Signature
Description
-----------
...
The ``extractLog`` directive is used for providing logging to routes, such that they don't have to depend on
closing over a logger provided in the class body.
See :ref:`-extract-` and :ref:`ProvideDirectives` for an overview of similar directives.
Example
-------

6
akka-docs-dev/rst/scala/http/routing-dsl/directives/basic-directives/extractRequestContext.rst
View file

@ -3,7 +3,11 @@
extractRequestContext
=====================
...
Extracts the request's underlying :class:`RequestContext`.
This directive is used as a building block for most of the other directives,
which extract the context and by inspecting some of it's values can decide
what to do with the request - for example provide a value, or reject the request.
Signature
---------

7
akka-docs-dev/rst/scala/http/routing-dsl/directives/basic-directives/extractSettings.rst
View file

@ -3,7 +3,7 @@
extractSettings
===============
...
Extracts the ``RoutingSettings`` from the :class:`RequestContext`.
Signature
---------
@ -14,7 +14,10 @@ Signature
Description
-----------
...
Extracts the ``RoutingSettings`` from the :class:`RequestContext`.
By default the settings of the ``Http()`` extension running the route will be returned.
It is possible to override the settings for specific sub-routes by using the :ref:`-withSettings-` directive.
Example
-------

8
akka-docs-dev/rst/scala/http/routing-dsl/directives/basic-directives/withExecutionContext.rst
View file

@ -3,7 +3,7 @@
withExecutionContext
====================
...
Runs its inner route with the given alternative :class:`ExecutionContext`.
Signature
---------
@ -14,7 +14,11 @@ Signature
Description
-----------
...
Allows running an inner route using an alternative ``ExecutionContext`` in place of the default one.
The execution context can be extracted in an inner route using :ref:`-extractExecutionContext-` directly,
or used by directives which internally extract the materializer without sufracing this fact in the API.
Example
-------

8
akka-docs-dev/rst/scala/http/routing-dsl/directives/basic-directives/withLog.rst
View file

@ -3,7 +3,7 @@
withLog
=======
...
Runs its inner route with the given alternative :class:`LoggingAdapter`.
Signature
---------
@ -14,7 +14,11 @@ Signature
Description
-----------
...
Allows running an inner route using an alternative :class:`LoggingAdapter` in place of the default one.
The logging adapter can be extracted in an inner route using :ref:`-extractLog-` directly,
or used by directives which internally extract the materializer without sufracing this fact in the API.
Example
-------

8
akka-docs-dev/rst/scala/http/routing-dsl/directives/basic-directives/withMaterializer.rst
View file

@ -3,7 +3,7 @@
withMaterializer
================
...
Runs its inner route with the given alternative ``Materializer``.
Signature
---------
@ -14,7 +14,11 @@ Signature
Description
-----------
...
Allows running an inner route using an alternative ``Materializer`` in place of the default one.
The materializer can be extracted in an inner route using :ref:`-extractMaterializer-` directly,
or used by directives which internally extract the materializer without sufracing this fact in the API
(e.g. responding with a Chunked entity).
Example
-------

7
akka-docs-dev/rst/scala/http/routing-dsl/directives/basic-directives/withSettings.rst
View file

@ -3,7 +3,7 @@
withSettings
============
...
Runs its inner route with the given alternative :class:`RoutingSettings`.
Signature
---------
@ -14,7 +14,10 @@ Signature
Description
-----------
...
Allows running an inner route using an alternative :class:`RoutingSettings` in place of the default one.
The execution context can be extracted in an inner route using :ref:`-extractSettings-` directly,
or used by directives which internally extract the materializer without sufracing this fact in the API.
Example
-------