aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.bindings.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual/cowboy_req.bindings.asciidoc')
-rw-r--r--doc/src/manual/cowboy_req.bindings.asciidoc46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.bindings.asciidoc b/doc/src/manual/cowboy_req.bindings.asciidoc
new file mode 100644
index 0000000..3e89859
--- /dev/null
+++ b/doc/src/manual/cowboy_req.bindings.asciidoc
@@ -0,0 +1,46 @@
+= cowboy_req:bindings(3)
+
+== Name
+
+cowboy_req:bindings - Access all values bound from the route
+
+== Description
+
+[source,erlang]
+----
+bindings(Req :: cowboy_req:req()) -> [{Name :: atom(), any()}]
+----
+
+Return all bindings as a list of key/value pairs.
+
+== Arguments
+
+Req::
+
+The Req object.
+
+== Return value
+
+By default values are case sensitive binary strings, however
+constraints may change the type of this value (for example
+automatically converting numbers to integer).
+
+== Changelog
+
+* *2.0*: Only the values are returned, it is no longer wrapped in a tuple.
+* *1.0*: Function introduced.
+
+== Examples
+
+.Get all bindings
+[source,erlang]
+----
+Bindings = cowboy_req:bindings(Req).
+----
+
+== See also
+
+link:man:cowboy_req(3)[cowboy_req(3)],
+link:man:cowboy_req:binding(3)[cowboy_req:binding(3)],
+link:man:cowboy_req:host_info(3)[cowboy_req:host_info(3)],
+link:man:cowboy_req:path_info(3)[cowboy_req:path_info(3)]