CookieJar.Cookie (cookie_jar v1.1.0) View Source

Model individual Cookie as specified by the MDN doc Some of the functionalities are irrelevant so only the following attributes are kept: domain, include_subdomain, path, secure, expires, name and value

Link to this section Summary

Types

t()

Functions

equal?(cookie1, cookie2)

Return true if cookie2 is superceding cookie1. Only compare domain, path and name.

matched?(cookie, uri)

Return true if the cookie shall be sent to the uri

new(name, value)

simple constructor

parse(set_cookie)

parse a cookie from the Set-Cookie: value. return nil if no valid cookie found

parse(set_cookie, uri)

parse a cookie from the Set-Cookie: value. return nil if no valid cookie found taking additional infomatio ffrom the requesting URI

to_string(cookie)

return name=value as string

Link to this section Types

t()

Specs

t() :: %CookieJar.Cookie{
  domain: String.t(),
  expires: integer(),
  include_subdomain: boolean(),
  name: String.t(),
  path: String.t(),
  secure: boolean(),
  value: String.t()
}

Link to this section Functions

equal?(cookie1, cookie2)

Specs

equal?(t(), t()) :: boolean()

Return true if cookie2 is superceding cookie1. Only compare domain, path and name.

matched?(cookie, uri)

Specs

matched?(t(), URI.t()) :: boolean()

Return true if the cookie shall be sent to the uri

new(name, value)

Specs

new(String.t(), String.t()) :: t()

simple constructor

parse(set_cookie)

Specs

parse(String.t()) :: nil | t()

parse a cookie from the Set-Cookie: value. return nil if no valid cookie found

parse(set_cookie, uri)

Specs

parse(String.t(), nil | URI.t()) :: nil | t()

parse a cookie from the Set-Cookie: value. return nil if no valid cookie found taking additional infomatio ffrom the requesting URI

to_string(cookie)

Specs

to_string(t()) :: String.t()

return name=value as string