aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.has_resp_body.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-12-21 15:47:44 +0100
committerLoïc Hoguin <[email protected]>2016-12-21 15:47:44 +0100
commitba14cf783820deb52ea0a810dd457ee179d7e30d (patch)
treef71d6ffe63e46c6d0a46088beb773c5661982562 /doc/src/manual/cowboy_req.has_resp_body.asciidoc
parentf57dd51e0f233df60c670009d83fb37058b765f2 (diff)
downloadcowboy-ba14cf783820deb52ea0a810dd457ee179d7e30d.tar.gz
cowboy-ba14cf783820deb52ea0a810dd457ee179d7e30d.tar.bz2
cowboy-ba14cf783820deb52ea0a810dd457ee179d7e30d.zip
Add man pages for the reply functions
Diffstat (limited to 'doc/src/manual/cowboy_req.has_resp_body.asciidoc')
-rw-r--r--doc/src/manual/cowboy_req.has_resp_body.asciidoc48
1 files changed, 48 insertions, 0 deletions
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)]