From 1b863c350ba1f9b8ad1cb458df514ab0fe6bb127 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 11 Dec 2017 11:27:17 +0100 Subject: Add documentation for Cowboy 2.2 --- .../cowboy/2.2/manual/cowboy_req.scheme/index.html | 226 +++++++++++++++++++++ 1 file changed, 226 insertions(+) create mode 100644 docs/en/cowboy/2.2/manual/cowboy_req.scheme/index.html (limited to 'docs/en/cowboy/2.2/manual/cowboy_req.scheme') diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.scheme/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.scheme/index.html new file mode 100644 index 00000000..43716750 --- /dev/null +++ b/docs/en/cowboy/2.2/manual/cowboy_req.scheme/index.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + Nine Nines: cowboy_req:scheme(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

cowboy_req:scheme(3)

+ +
+

Name

+
+

cowboy_req:scheme - URI scheme

+
+
+
+

Description

+
+
+
+
scheme(Req :: cowboy_req:req()) -> Scheme :: binary()
+

Return the scheme of the effective request URI.

+

The scheme can also be obtained using pattern matching:

+
+
+
#{scheme := Scheme} = Req.
+
+
+
+

Arguments

+
+
+
+Req +
+
+

+The Req object. +

+
+
+
+
+
+

Return value

+
+

The scheme is returned as a binary. It is case insensitive.

+

Cowboy will only set the scheme to <<"http">> or <<"https">>.

+
+
+
+

Changelog

+
+
    +
  • +

    +2.0: Function introduced. +

    +
    • +
+
+
+
+

Examples

+
+
+
Redirect HTTP to HTTPS
+
+
init(Req0=#{scheme := <<"http">>}, State) ->
+    Req = cowboy_req:reply(302, #{
+        <<"location">> => cowboy_req:uri(Req, #{scheme => <<"https">>})
+    }, Req0),
+    {ok, Req, State};
+init(Req, State) ->
+    {cowboy_rest, Req, State}.
+
+
+
+

See also

+
+

cowboy_req(3)

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

+ Cowboy + 2.2 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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