blob: bbe147dbeacab612b453459c56a2d9802b2f73d4 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
= cowboy_req:scheme(3)
== Name
cowboy_req:scheme - URI scheme
== Description
[source,erlang]
----
scheme(Req :: cowboy_req:req()) -> Scheme :: binary()
----
Return the scheme of the effective request URI.
The scheme can also be obtained using pattern matching:
[source,erlang]
----
#{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
[source,erlang]
----
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
link:man:cowboy_req(3)[cowboy_req(3)]
|