aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cow_cookie.parse_cookie.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2019-10-04 15:19:17 +0200
committerLoïc Hoguin <[email protected]>2019-10-04 15:19:17 +0200
commitbd32d879e151ba6fa1732b4eee6cac064846e9cc (patch)
treed9605b974f102327b6c096f413d0c7b797768353 /doc/src/manual/cow_cookie.parse_cookie.asciidoc
parent6a4f901c7938a070cf7a80fdb366e17f8a300aff (diff)
downloadcowlib-bd32d879e151ba6fa1732b4eee6cac064846e9cc.tar.gz
cowlib-bd32d879e151ba6fa1732b4eee6cac064846e9cc.tar.bz2
cowlib-bd32d879e151ba6fa1732b4eee6cac064846e9cc.zip
Add manual for cow_cookie
Diffstat (limited to 'doc/src/manual/cow_cookie.parse_cookie.asciidoc')
-rw-r--r--doc/src/manual/cow_cookie.parse_cookie.asciidoc44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/src/manual/cow_cookie.parse_cookie.asciidoc b/doc/src/manual/cow_cookie.parse_cookie.asciidoc
new file mode 100644
index 0000000..0b7393e
--- /dev/null
+++ b/doc/src/manual/cow_cookie.parse_cookie.asciidoc
@@ -0,0 +1,44 @@
+= cow_cookie:parse_cookie(3)
+
+== Name
+
+cow_cookie:parse_cookie - Parse a cookie header
+
+== Description
+
+[source,erlang]
+----
+parse_cookie(Cookie :: binary())
+ -> [{binary(), binary()}]
+----
+
+Parse a cookie header.
+
+== Arguments
+
+Cookie::
+
+The cookie header value.
+
+== Return value
+
+A list of cookie name/value pairs is returned on success.
+
+An exception is thrown in the event of a parse error.
+
+== Changelog
+
+* *1.0*: Function introduced.
+
+== Examples
+
+.Parse a cookie header
+[source,erlang]
+----
+Cookies = cow_cookie:parse_cookie(CookieHd).
+----
+
+== See also
+
+link:man:cow_cookie(3)[cow_cookie(3)],
+link:man:cow_cookie:setcookie(3)[cow_cookie:setcookie(3)]