From 48f39402181d959cad88cb3f460210c007169f50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 12 May 2021 11:13:47 +0200 Subject: Cowboy 2.9.0 --- .../2.9/manual/cowboy_req.binding/index.html | 212 +++++++++++++++++++++ 1 file changed, 212 insertions(+) create mode 100644 docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html (limited to 'docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html') diff --git a/docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html b/docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html new file mode 100644 index 00000000..f492981b --- /dev/null +++ b/docs/en/cowboy/2.9/manual/cowboy_req.binding/index.html @@ -0,0 +1,212 @@ + + + + + + + + + + Nine Nines: cowboy_req:binding(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

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)

+ + + + + + +
+ +
+ + +

+ Cowboy + 2.9 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3