From 92b54aacc0de5446dd5497c39897b0bbff72e626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Jun 2018 09:54:12 +0200 Subject: Rebuild using Asciideck --- .../2.4/manual/cowboy_req.binding/index.html | 122 ++++++--------------- 1 file changed, 33 insertions(+), 89 deletions(-) (limited to 'docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html') diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html index 46d46121..95666a38 100644 --- a/docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.4/manual/cowboy_req.binding/index.html @@ -62,116 +62,60 @@

cowboy_req:binding(3)

-

Name

-
-

cowboy_req:binding - Access a value bound from the route

-
-
-
+

cowboy_req:binding - Access a value bound from the route

Description

-
-
-
-
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.

-
-
-
+
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. -

+
Name
+

Desired binding name as an atom.

-
-Req -
-
-

-The Req object. -

+
Req
+

The Req object.

-
-Default -
-
-

-Default value returned when the binding is missing. -

+
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).

-
-
-
+

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. -

    +
    • 2.0: Only the value is returned, it is no longer wrapped in a tuple.
      • -
    • -

      -1.0: Function introduced. -

      +
    • 1.0: Function introduced.
      • -
-
-
-
+

Examples

-
-
-
Get the username from the path
-
-
%% Route is "/users/:user"
-Username = cowboy_req:binding(user, Req).
-
-
Get the branch name, with a default
-
-
%% Route is "/log[/:branch]"
-Branch = cowboy_req:binding(branch, Req, <<"master">>)
-
-
-
+
%% Route is "/log[/:branch]"
+Branch = cowboy_req:binding(branch, Req, <<"master">>)
+

See also

-
-

cowboy_req(3), -cowboy_req:bindings(3), -cowboy_req:host_info(3), -cowboy_req:path_info(3), -cowboy_router(3)

-
- +

cowboy_req(3), cowboy_req:bindings(3), cowboy_req:host_info(3), cowboy_req:path_info(3), cowboy_router(3)

+ -- cgit v1.2.3