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.body_length.asciidoc | 51 ++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 doc/src/manual/cowboy_req.body_length.asciidoc (limited to 'doc/src/manual/cowboy_req.body_length.asciidoc') 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)] -- cgit v1.2.3