From b5d4cb91f80c833795a2d87050c3674bb7aecdc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 3 Oct 2017 13:39:41 +0200 Subject: Update Hugo, docs --- .../2.0/manual/cowboy_req.binding/index.html | 222 ++++++++++----------- 1 file changed, 111 insertions(+), 111 deletions(-) (limited to 'docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html') diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html index 27bf3764..94112847 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_req.binding/index.html @@ -7,7 +7,7 @@ - + Nine Nines: cowboy_req:binding(3) @@ -67,116 +67,116 @@

cowboy_req:binding(3)

-
-

Name

-
-

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.

-
-
-
-

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
-
-
%% 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">>)
-
-
-
-

See also

-
-

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

-
-
+
+

Name

+
+

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.

+
+
+
+

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
+
+
%% 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">>)
+
+
+
+

See also

+
+

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

+
+
-- cgit v1.2.3