aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.has_body.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-12-02 16:50:31 +0100
committerLoïc Hoguin <[email protected]>2016-12-02 16:50:55 +0100
commitc528d9b0f7698b5b901cbc8841a96fb4bd38aba9 (patch)
treebda658f088bc5b615f26f8acfdae22c43cebcb85 /doc/src/manual/cowboy_req.has_body.asciidoc
parent7b248e5163fd852d6defe967318da849433dadb1 (diff)
downloadcowboy-c528d9b0f7698b5b901cbc8841a96fb4bd38aba9.tar.gz
cowboy-c528d9b0f7698b5b901cbc8841a96fb4bd38aba9.tar.bz2
cowboy-c528d9b0f7698b5b901cbc8841a96fb4bd38aba9.zip
Add the man pages for body reading functions
[ci skip]
Diffstat (limited to 'doc/src/manual/cowboy_req.has_body.asciidoc')
-rw-r--r--doc/src/manual/cowboy_req.has_body.asciidoc45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.has_body.asciidoc b/doc/src/manual/cowboy_req.has_body.asciidoc
new file mode 100644
index 0000000..5e985b1
--- /dev/null
+++ b/doc/src/manual/cowboy_req.has_body.asciidoc
@@ -0,0 +1,45 @@
+= cowboy_req:has_body(3)
+
+== Name
+
+cowboy_req:has_body - Is there a request body?
+
+== Description
+
+[source,erlang]
+----
+has_body(Req :: cowboy_req:req()) -> boolean()
+----
+
+Return whether the request has a body.
+
+== Arguments
+
+Req::
+
+The Req object.
+
+== Return value
+
+A boolean indicating whether the request has a body.
+
+== Changelog
+
+* *1.0*: Function introduced.
+
+== Examples
+
+.Ensure the request has a body
+[source,erlang]
+----
+true = cowboy_req:has_body(Req).
+----
+
+== See also
+
+link:man:cowboy_req(3)[cowboy_req(3)],
+link:man:cowboy_req:body_length(3)[cowboy_req:body_length(3)],
+link:man:cowboy_req:read_body(3)[cowboy_req:read_body(3)],
+link:man:cowboy_req:read_urlencoded_body(3)[cowboy_req:read_urlencoded_body(3)],
+link:man:cowboy_req:read_part(3)[cowboy_req:read_part(3)],
+link:man:cowboy_req:read_part_body(3)[cowboy_req:read_part_body(3)]