From d2a3f2cedd7c00d0933222aed9c06b3149aa4db4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 4 Apr 2018 13:13:37 +0200 Subject: Cowboy 2.3.0 --- .../2.3/manual/cowboy_req.set_resp_body/index.html | 277 +++++++++++++++++++++ 1 file changed, 277 insertions(+) create mode 100644 docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html (limited to 'docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html') diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html new file mode 100644 index 00000000..113c8785 --- /dev/null +++ b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/index.html @@ -0,0 +1,277 @@ + + + + + + + + + + + + Nine Nines: cowboy_req:set_resp_body(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

cowboy_req:set_resp_body(3)

+ +
+

Name

+
+

cowboy_req:set_resp_body - Set the response body

+
+
+
+

Description

+
+
+
+
set_resp_body(Body, Req :: cowboy_req:req())
+        -> Req
+
+Body :: cowboy_req:resp_body()
+

Set the response body.

+

The response body will be sent when a reply is initiated. +Note that the functions stream_reply/2,3 and reply/4 +will override the body set by this function.

+

This function can also be used to remove a response body +that was set previously. To do so, simply call this function +with an empty body.

+
+
+
+

Arguments

+
+
+
+Body +
+
+

+The body can be either a binary value, an iolist or a +sendfile tuple telling Cowboy to send the contents of +a file. +

+
+
+Req +
+
+

+The Req object. +

+
+
+
+
+
+

Return value

+
+

A new Req object is returned.

+

The returned Req object must be used from that point onward, +otherwise the body will not be sent in the response.

+
+
+
+

Changelog

+
+
    +
  • +

    +2.0: The function now accepts a sendfile tuple. +

    +
    • +
  • +

    +2.0: The set_resp_body_fun/2,3 functions were removed. +

    +
    • +
  • +

    +1.0: Function introduced. +

    +
    • +
+
+
+
+

Examples

+
+
+
Set the response body
+
+
Req = cowboy_req:set_resp_body(<<"Hello world!">>, Req0).
+
+
Set the response body as an iolist
+
+
Req = cowboy_req:set_resp_body([
+    "<html><head><title>",
+    page_title(),
+    "</title></head><body>",
+    page_body(),
+    "</body></html>"
+], Req0).
+
+
Tell Cowboy to send data from a file
+
+
{ok, #file_info{size=Size}} = file:read_file_info(Filename),
+Req = cowboy_req:set_resp_body({sendfile, 0, Size, Filename}, Req0).
+
+
Clear any previously set response body
+
+
Req = cowboy_req:set_resp_body(<<>>, Req0).
+
+
+
+

See also

+
+

cowboy_req(3), +cowboy_req:set_resp_header(3), +cowboy_req:set_resp_headers(3), +cowboy_req:reply(3), +cowboy_req:stream_reply(3)

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

+ Cowboy + 2.3 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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