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
51
doc/src/manual/cowboy_req.headers.asciidoc
Normal file
51
doc/src/manual/cowboy_req.headers.asciidoc
Normal file
|
@ -0,0 +1,51 @@
|
|||
= cowboy_req:headers(3)
|
||||
|
||||
== Name
|
||||
|
||||
cowboy_req:headers - HTTP headers
|
||||
|
||||
== Description
|
||||
|
||||
[source,erlang]
|
||||
----
|
||||
headers(Req :: cowboy_req:req()) -> cowboy:http_headers()
|
||||
----
|
||||
|
||||
Return all request headers.
|
||||
|
||||
Request headers can also be obtained using pattern matching:
|
||||
|
||||
[source,erlang]
|
||||
----
|
||||
#{headers := Headers} = Req.
|
||||
----
|
||||
|
||||
== Arguments
|
||||
|
||||
Req::
|
||||
|
||||
The Req object.
|
||||
|
||||
== Return value
|
||||
|
||||
Headers are returned as a map with keys being lowercase
|
||||
binary strings, and values as binary strings.
|
||||
|
||||
== Changelog
|
||||
|
||||
* *2.0*: Only the headers are returned, they are no longer wrapped in a tuple.
|
||||
* *1.0*: Function introduced.
|
||||
|
||||
== Examples
|
||||
|
||||
.Get all headers
|
||||
[source,erlang]
|
||||
----
|
||||
Headers = cowboy_req:headers(Req).
|
||||
----
|
||||
|
||||
== See also
|
||||
|
||||
link:man:cowboy_req(3)[cowboy_req(3)],
|
||||
link:man:cowboy_req:header(3)[cowboy_req:header(3)],
|
||||
link:man:cowboy_req:parse_header(3)[cowboy_req:parse_header(3)]
|
Loading…
Add table
Add a link
Reference in a new issue