From 1b863c350ba1f9b8ad1cb458df514ab0fe6bb127 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 11 Dec 2017 11:27:17 +0100 Subject: Add documentation for Cowboy 2.2 --- .../cowboy/2.2/manual/cowboy_req.header/index.html | 259 +++++++++++++++++++++ 1 file changed, 259 insertions(+) create mode 100644 docs/en/cowboy/2.2/manual/cowboy_req.header/index.html (limited to 'docs/en/cowboy/2.2/manual/cowboy_req.header/index.html') diff --git a/docs/en/cowboy/2.2/manual/cowboy_req.header/index.html b/docs/en/cowboy/2.2/manual/cowboy_req.header/index.html new file mode 100644 index 00000000..ba52fcd2 --- /dev/null +++ b/docs/en/cowboy/2.2/manual/cowboy_req.header/index.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + Nine Nines: cowboy_req:header(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

cowboy_req:header(3)

+ +
+

Name

+
+

cowboy_req:header - HTTP header

+
+
+
+

Description

+
+
+
+
header(Name, Req)          -> header(Name, Req, undefined)
+header(Name, Req, Default) -> binary() | Default
+
+Name    :: binary()          %% lowercase; case insensitive
+Req     :: cowboy_req:req()
+Default :: any()
+

Return the value for the given HTTP header.

+

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.

+

Headers can also be obtained using pattern matching:

+
+
+
#{headers := #{Name := Value}} = Req.
+

Note that this snippet will crash if the header is missing.

+
+
+
+

Arguments

+
+
+
+Name +
+
+

+Desired HTTP header name as a lowercase binary string. +

+
+
+Req +
+
+

+The Req object. +

+
+
+Default +
+
+

+Default value returned when the header is missing. +

+
+
+
+
+
+

Return value

+
+

The header value is returned as a binary string. When the +header is missing, the default argument is returned.

+
+
+
+

Changelog

+
+
    +
  • +

    +2.0: Only the header value is returned, it is no longer wrapped in a tuple. +

    +
    • +
  • +

    +1.0: Function introduced. +

    +
    • +
+
+
+
+

Examples

+
+
+
Get the accept header
+
+
Accept = cowboy_req:header(<<"accept">>, Req).
+
+
Get the content-length header with a default value
+
+
Length = cowboy_req:header(<<"content-length">>, Req, <<"0">>).
+
+
+
+

See also

+
+

cowboy_req(3), +cowboy_req:headers(3), +cowboy_req:parse_header(3)

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

+ Cowboy + 2.2 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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