From c528d9b0f7698b5b901cbc8841a96fb4bd38aba9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 2 Dec 2016 16:50:31 +0100 Subject: Add the man pages for body reading functions [ci skip] --- doc/src/manual/cowboy_req.has_body.asciidoc | 45 +++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 doc/src/manual/cowboy_req.has_body.asciidoc (limited to 'doc/src/manual/cowboy_req.has_body.asciidoc') 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)] -- cgit v1.2.3