From 13fd7a716c82f384f42f4dfb6c3e8a6b90f72054 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 2 Dec 2016 16:53:43 +0100 Subject: Update documentation --- .../2.0/manual/cowboy_req.body_length/index.html | 227 +++++++++++++++++++++ 1 file changed, 227 insertions(+) create mode 100644 docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html (limited to 'docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html') diff --git a/docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html b/docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html new file mode 100644 index 00000000..0b200a7c --- /dev/null +++ b/docs/en/cowboy/2.0/manual/cowboy_req.body_length/index.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + Nine Nines: cowboy_req:body_length(3) + + + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

cowboy_req:body_length(3)

+ +
+

Name

+
+

cowboy_req:body_length - Body length

+
+
+
+

Description

+
+
+
+
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
+
+
Length = cowboy_req:body_length(Req).
+
+
+
+

See also

+
+

cowboy_req(3), +cowboy_req:has_body(3), +cowboy_req:read_body(3), +cowboy_req:read_urlencoded_body(3), +cowboy_req:read_part(3), +cowboy_req:read_part_body(3)

+
+
+ + + + + +
+ +
+ + +

+ Cowboy + 2.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +
+
+
+
+ + + + + + + + + + + + -- cgit v1.2.3