27efafecfc
* Correct type of response in logging directive samples #21009 * Updates to signatures in the docs as well
36 lines
1.3 KiB
ReStructuredText
36 lines
1.3 KiB
ReStructuredText
.. _-logResult-:
|
|
|
|
logResult
|
|
=========
|
|
|
|
Signature
|
|
---------
|
|
|
|
::
|
|
|
|
def logResult(marker: String)(implicit log: LoggingContext): Directive0
|
|
def logResult(marker: String, level: LogLevel)(implicit log: LoggingContext): Directive0
|
|
def logResult(show: RouteResult => String)(implicit log: LoggingContext): Directive0
|
|
def logResult(show: RouteResult => LogEntry)(implicit log: LoggingContext): Directive0
|
|
def logResult(magnet: LoggingMagnet[RouteResult => Unit])(implicit log: LoggingContext): Directive0
|
|
|
|
The signature shown is simplified, the real signature uses magnets. [1]_
|
|
|
|
.. [1] See `The Magnet Pattern`_ for an explanation of magnet-based overloading.
|
|
.. _`The Magnet Pattern`: http://spray.io/blog/2012-12-13-the-magnet-pattern/
|
|
|
|
Description
|
|
-----------
|
|
Logs the response.
|
|
|
|
See :ref:`-logRequest-` for the general description how these directives work. This directive is different
|
|
as it requires a ``LoggingMagnet[RouteResult => Unit]``. Instead of just logging ``HttpResponses``, ``logResult`` is able to
|
|
log any :ref:`RouteResult` coming back from the inner route.
|
|
|
|
Use ``logRequest`` for logging the request, or ``logRequestResult`` for logging both.
|
|
|
|
Example
|
|
-------
|
|
|
|
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/DebuggingDirectivesExamplesSpec.scala
|
|
:snippet: logResult
|