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.version.asciidoc | 49 ++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 doc/src/manual/cowboy_req.version.asciidoc (limited to 'doc/src/manual/cowboy_req.version.asciidoc') diff --git a/doc/src/manual/cowboy_req.version.asciidoc b/doc/src/manual/cowboy_req.version.asciidoc new file mode 100644 index 0000000..15920c4 --- /dev/null +++ b/doc/src/manual/cowboy_req.version.asciidoc @@ -0,0 +1,49 @@ += cowboy_req:version(3) + +== Name + +cowboy_req:version - HTTP version + +== Description + +[source,erlang] +---- +version(Req :: cowboy_req:req()) -> Version :: cowboy:http_version() +---- + +Return the HTTP version used for the request. + +The version can also be obtained using pattern matching: + +[source,erlang] +---- +#{version := Version} = Req. +---- + +== Arguments + +Req:: + +The Req object. + +== Return value + +The HTTP version used for the request is returned as an +atom. It is provided for informative purposes only. + +== Changelog + +* *2.0*: Only the version is returned, it is no longer wrapped in a tuple. +* *1.0*: Function introduced. + +== Examples + +.Get the HTTP version +[source,erlang] +---- +Version = cowboy_req:version(Req). +---- + +== See also + +link:man:cowboy_req(3)[cowboy_req(3)] -- cgit v1.2.3