From 92b54aacc0de5446dd5497c39897b0bbff72e626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Jun 2018 09:54:12 +0200 Subject: Rebuild using Asciideck --- .../manual/cowboy_req.set_resp_headers/index.html | 116 ++++++--------------- 1 file changed, 29 insertions(+), 87 deletions(-) (limited to 'docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html') diff --git a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html index 9b76cc9f..e22407e6 100644 --- a/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html +++ b/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/index.html @@ -62,109 +62,51 @@

cowboy_req:set_resp_headers(3)

-

Name

-
-

cowboy_req:set_resp_headers - Set several response headers

-
-
-
+

cowboy_req:set_resp_headers - Set several response headers

Description

-
-
-
-
set_resp_headers(Headers, Req :: cowboy_req:req())
-    -> Req
-
-Headers :: cowboy:http_headers()
-

Set several headers to be sent with the response.

-

The header name must be given as a lowercase binary string. -While header names are case insensitive, Cowboy requires them -to be given as lowercase to function properly.

-

Cowboy does not allow duplicate header names. Headers set -by this function may be overwritten by those set from the -reply functions. Likewise, headers set by this function may -overwrite headers that were set previously.

-

Use cowboy_req:set_resp_cookie(3) -instead of this function to set cookies.

-
-
-
+
set_resp_headers(Headers, Req :: cowboy_req:req())
+    -> Req
+
+Headers :: cowboy:http_headers()
+
+

Set several headers to be sent with the response.

+

The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.

+

Cowboy does not allow duplicate header names. Headers set by this function may be overwritten by those set from the reply functions. Likewise, headers set by this function may overwrite headers that were set previously.

+

Use cowboy_req:set_resp_cookie(3) instead of this function to set cookies.

Arguments

-
-
-
-Headers -
-
-

-Headers as a map with keys being lowercase binary strings, -and values as binary strings. -

+
Headers
+

Headers as a map with keys being lowercase binary strings, and values as binary strings.

-
-Req -
-
-

-The Req object. -

+
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 headers will not be sent in the response.

-
-
-
+

A new Req object is returned.

+

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

Changelog

-
-
    -
  • -

    -2.0: Function introduced. -

    +
    • 2.0: Function introduced.
      • -
-
-
-
+

Examples

-
-
-
Set several response headers
-
-
Req = cowboy_req:set_resp_headers(#{
-    <<"content-type">>     => <<"text/html">>,
-    <<"content-encoding">> => <<"gzip">>
-}, Req0).
-
-
-
+
Req = cowboy_req:set_resp_headers(#{
+    <<"content-type">>     => <<"text/html">>,
+    <<"content-encoding">> => <<"gzip">>
+}, Req0).
+

See also

-
-

cowboy_req(3), -cowboy_req:set_resp_cookie(3), -cowboy_req:set_resp_header(3), -cowboy_req:has_resp_header(3), -cowboy_req:resp_header(3), -cowboy_req:resp_headers(3), -cowboy_req:delete_resp_header(3), -cowboy_req:reply(3), -cowboy_req:stream_reply(3)

-
- +

cowboy_req(3), cowboy_req:set_resp_cookie(3), cowboy_req:set_resp_header(3), cowboy_req:has_resp_header(3), cowboy_req:resp_header(3), cowboy_req:resp_headers(3), cowboy_req:delete_resp_header(3), cowboy_req:reply(3), cowboy_req:stream_reply(3)

+ -- cgit v1.2.3