aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.body_length.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.body_length.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.body_length.asciidoc')
-rw-r--r--doc/src/manual/cowboy_req.body_length.asciidoc51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.body_length.asciidoc b/doc/src/manual/cowboy_req.body_length.asciidoc
new file mode 100644
index 0000000..057ab4c
--- /dev/null
+++ b/doc/src/manual/cowboy_req.body_length.asciidoc
@@ -0,0 +1,51 @@
+= cowboy_req:body_length(3)
+
+== Name
+
+cowboy_req:body_length - Body length
+
+== Description
+
+[source,erlang]
+----
+body_length(Req :: cowboy_req:req()) -> undefined | non_neg_integer()
+----
+
+Return the length of the request body.
+
+The length is not always known before reading the body.
+In those cases Cowboy will return `undefined`. The body
+length is available after the body has been fully read.
+
+== Arguments
+
+Req::
+
+The Req object.
+
+== Return value
+
+The length of the request body, or `undefined` if it is
+not known.
+
+== Changelog
+
+* *2.0*: Only the length is returned, it is no longer wrapped in a tuple.
+* *1.0*: Function introduced.
+
+== Examples
+
+.Get the body length
+[source,erlang]
+----
+Length = cowboy_req:body_length(Req).
+----
+
+== See also
+
+link:man:cowboy_req(3)[cowboy_req(3)],
+link:man:cowboy_req:has_body(3)[cowboy_req:has_body(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)]