diff options
author | Loïc Hoguin <[email protected]> | 2016-11-05 14:17:30 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2016-11-05 14:17:30 +0200 |
commit | faca7866ed1c59cd41e11fcfc5a9f95378380497 (patch) | |
tree | 7e33284b3426083154b7a1d52ae5db8996212739 /doc/src/manual/cowboy_req.scheme.asciidoc | |
parent | 8fe700f341d324c44f6c5f196f8c699c85ee6d78 (diff) | |
download | cowboy-faca7866ed1c59cd41e11fcfc5a9f95378380497.tar.gz cowboy-faca7866ed1c59cd41e11fcfc5a9f95378380497.tar.bz2 cowboy-faca7866ed1c59cd41e11fcfc5a9f95378380497.zip |
Partially update manual for the cowboy_req
Only the access functions have been modified so far.
Diffstat (limited to 'doc/src/manual/cowboy_req.scheme.asciidoc')
-rw-r--r-- | doc/src/manual/cowboy_req.scheme.asciidoc | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.scheme.asciidoc b/doc/src/manual/cowboy_req.scheme.asciidoc new file mode 100644 index 0000000..bbe147d --- /dev/null +++ b/doc/src/manual/cowboy_req.scheme.asciidoc @@ -0,0 +1,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)] |