From faca7866ed1c59cd41e11fcfc5a9f95378380497 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 5 Nov 2016 14:17:30 +0200 Subject: Partially update manual for the cowboy_req Only the access functions have been modified so far. --- doc/src/manual/cowboy_req.headers.asciidoc | 51 ++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 doc/src/manual/cowboy_req.headers.asciidoc (limited to 'doc/src/manual/cowboy_req.headers.asciidoc') diff --git a/doc/src/manual/cowboy_req.headers.asciidoc b/doc/src/manual/cowboy_req.headers.asciidoc new file mode 100644 index 0000000..c370f6d --- /dev/null +++ b/doc/src/manual/cowboy_req.headers.asciidoc @@ -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)] -- cgit v1.2.3