From ba14cf783820deb52ea0a810dd457ee179d7e30d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 21 Dec 2016 15:47:44 +0100 Subject: Add man pages for the reply functions --- doc/src/manual/cowboy_req.has_resp_body.asciidoc | 48 ++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 doc/src/manual/cowboy_req.has_resp_body.asciidoc (limited to 'doc/src/manual/cowboy_req.has_resp_body.asciidoc') diff --git a/doc/src/manual/cowboy_req.has_resp_body.asciidoc b/doc/src/manual/cowboy_req.has_resp_body.asciidoc new file mode 100644 index 0000000..d6b9068 --- /dev/null +++ b/doc/src/manual/cowboy_req.has_resp_body.asciidoc @@ -0,0 +1,48 @@ += cowboy_req:has_resp_body(3) + +== Name + +cowboy_req:has_resp_body - Is there a response body? + +== Description + +[source,erlang] +---- +has_resp_body(Req :: cowboy_req:req()) -> boolean() +---- + +Return whether a response body has been set. + +== Arguments + +Req:: + +The Req object. + +== Return value + +A boolean indicating whether a response body has been set. + +This function will return `false` when an empty response +body has been set. + +== Changelog + +* *1.0*: Function introduced. + +== Examples + +.Check whether a body has been set +[source,erlang] +---- +false = cowboy_req:has_resp_body(Req0), +Req1 = cowboy_req:set_resp_body(<<"Hello!">>, Req0), +true = cowboy_req:has_resp_body(Req1), +Req = cowboy_req:set_resp_body(<<>>, Req1), +false = cowboy_req:has_resp_body(Req). +---- + +== See also + +link:man:cowboy_req(3)[cowboy_req(3)], +link:man:cowboy_req:set_resp_body(3)[cowboy_req:set_resp_body(3)] -- cgit v1.2.3