0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 20:50:24 +00:00

Add man pages for the parse/match/binding cowboy_req functions

This commit is contained in:
Loïc Hoguin 2016-11-07 18:03:47 +02:00
parent bd34dfdedd
commit 7b248e5163
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
8 changed files with 371 additions and 7 deletions

View file

@ -0,0 +1,67 @@
= cowboy_req:binding(3)
== Name
cowboy_req:binding - Access a value bound from the route
== Description
[source,erlang]
----
binding(Name, Req) -> binding(Name, Req, undefined)
binding(Name, Req, Default) -> any() | Default
Name :: atom()
Req :: cowboy_req:req()
Default :: any()
----
Return the value for the given binding.
== Arguments
Name::
Desired binding name as an atom.
Req::
The Req object.
Default::
Default value returned when the binding is missing.
== Return value
By default the value is a case sensitive binary string, however
constraints may change the type of this value (for example
automatically converting numbers to integer).
== Changelog
* *2.0*: Only the value is returned, it is no longer wrapped in a tuple.
* *1.0*: Function introduced.
== Examples
.Get the username from the path
[source,erlang]
----
%% Route is "/users/:user"
Username = cowboy_req:binding(user, Req).
----
.Get the branch name, with a default
[source,erlang]
----
%% Route is "/log[/:branch]"
Branch = cowboy_req:binding(branch, Req, <<"master">>)
----
== See also
link:man:cowboy_req(3)[cowboy_req(3)],
link:man:cowboy_req:bindings(3)[cowboy_req:bindings(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)]