mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-14 20:30:23 +00:00
Partially update manual for the cowboy_req
Only the access functions have been modified so far.
This commit is contained in:
parent
8fe700f341
commit
faca7866ed
16 changed files with 1409 additions and 895 deletions
55
doc/src/manual/cowboy_req.scheme.asciidoc
Normal file
55
doc/src/manual/cowboy_req.scheme.asciidoc
Normal file
|
@ -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)]
|
Loading…
Add table
Add a link
Reference in a new issue