From 7b248e5163fd852d6defe967318da849433dadb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 7 Nov 2016 18:03:47 +0200 Subject: Add man pages for the parse/match/binding cowboy_req functions --- doc/src/manual/cowboy_req.host_info.asciidoc | 48 ++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 doc/src/manual/cowboy_req.host_info.asciidoc (limited to 'doc/src/manual/cowboy_req.host_info.asciidoc') diff --git a/doc/src/manual/cowboy_req.host_info.asciidoc b/doc/src/manual/cowboy_req.host_info.asciidoc new file mode 100644 index 0000000..77a4c11 --- /dev/null +++ b/doc/src/manual/cowboy_req.host_info.asciidoc @@ -0,0 +1,48 @@ += cowboy_req:host_info(3) + +== Name + +cowboy_req:host_info - Access the route's heading host segments + +== Description + +[source,erlang] +---- +host_info(Req :: cowboy_req:req()) -> cowboy_router:tokens() +---- + +Return the tokens for the heading host segments. + +This is the part of the host name that was matched using +the `...` notation. + +== Arguments + +Req:: + +The Req object. + +== Return value + +The tokens are returned as a list of case insensitive +binary strings. + +== Changelog + +* *2.0*: Only the tokens are returned, they are no longer wrapped in a tuple. +* *1.0*: Function introduced. + +== Examples + +.Get the host_info tokens +[source,erlang] +---- +HostInfo = cowboy_req:host_info(Req). +---- + +== See also + +link:man:cowboy_req(3)[cowboy_req(3)], +link:man:cowboy_req:binding(3)[cowboy_req:binding(3)], +link:man:cowboy_req:bindings(3)[cowboy_req:bindings(3)], +link:man:cowboy_req:path_info(3)[cowboy_req:path_info(3)] -- cgit v1.2.3