=doc Move formField directives' docs to a correct directory
This commit is contained in:
parent
ec18320d5a
commit
5a7a48824e
3 changed files with 0 additions and 0 deletions
|
|
@ -0,0 +1,29 @@
|
|||
.. _-formFieldMap-:
|
||||
|
||||
formFieldMap
|
||||
============
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FormFieldDirectives.scala
|
||||
:snippet: formFieldMap
|
||||
|
||||
Description
|
||||
-----------
|
||||
Extracts all HTTP form fields at once as a ``Map[String, String]`` mapping form field names to form field values.
|
||||
|
||||
If form data contain a field value several times, the map will contain the last one.
|
||||
|
||||
See :ref:`-formFields-` for an in-depth description.
|
||||
|
||||
Warning
|
||||
-------
|
||||
Use of this directive can result in performance degradation or even in ``OutOfMemoryError`` s.
|
||||
See :ref:`-formFieldSeq-` for details.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/FormFieldDirectivesExamplesSpec.scala
|
||||
:snippet: formFieldMap
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
.. _-formFieldMultiMap-:
|
||||
|
||||
formFieldMultiMap
|
||||
=================
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FormFieldDirectives.scala
|
||||
:snippet: formFieldMultiMap
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Extracts all HTTP form fields at once as a multi-map of type ``Map[String, List[String]`` mapping
|
||||
a form name to a list of all its values.
|
||||
|
||||
This directive can be used if form fields can occur several times.
|
||||
|
||||
The order of values is *not* specified.
|
||||
|
||||
See :ref:`-formFields-` for an in-depth description.
|
||||
|
||||
Warning
|
||||
-------
|
||||
Use of this directive can result in performance degradation or even in ``OutOfMemoryError`` s.
|
||||
See :ref:`-formFieldSeq-` for details.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/FormFieldDirectivesExamplesSpec.scala
|
||||
:snippet: formFieldMultiMap
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
.. _-formFieldSeq-:
|
||||
|
||||
formFieldSeq
|
||||
============
|
||||
|
||||
Signature
|
||||
---------
|
||||
|
||||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/FormFieldDirectives.scala
|
||||
:snippet: formFieldSeq
|
||||
|
||||
Description
|
||||
-----------
|
||||
Extracts all HTTP form fields at once in the original order as (name, value) tuples of type ``(String, String)``.
|
||||
|
||||
This directive can be used if the exact order of form fields is important or if parameters can occur several times.
|
||||
|
||||
See :ref:`-formFields-` for an in-depth description.
|
||||
|
||||
Warning
|
||||
-------
|
||||
The directive reads all incoming HTT form fields without any configured upper bound.
|
||||
It means, that requests with form fields holding significant amount of data (ie. during a file upload)
|
||||
can cause performance issues or even an ``OutOfMemoryError`` s.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/FormFieldDirectivesExamplesSpec.scala
|
||||
:snippet: formFieldSeq
|
||||
Loading…
Add table
Add a link
Reference in a new issue