From 7b248e5163fd852d6defe967318da849433dadb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 7 Nov 2016 18:03:47 +0200 Subject: Add man pages for the parse/match/binding cowboy_req functions --- doc/src/manual/cowboy_req.bindings.asciidoc | 46 +++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 doc/src/manual/cowboy_req.bindings.asciidoc (limited to 'doc/src/manual/cowboy_req.bindings.asciidoc') 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)] -- cgit v1.2.3