Struct hyper::header::SetCookie

pub struct SetCookie(pub Vec<Cookie>);

Set-Cookie header, defined RFC6265

The Set-Cookie HTTP response header is used to send cookies from the server to the user agent.

Informally, the Set-Cookie response header contains the header name "Set-Cookie" followed by a ":" and a cookie. Each cookie begins with a name-value-pair, followed by zero or more attribute-value pairs.

ABNF

 set-cookie-header = "Set-Cookie:" SP set-cookie-string
set-cookie-string = cookie-pair *( ";" SP cookie-av )
cookie-pair       = cookie-name "=" cookie-value
cookie-name       = token
cookie-value      = *cookie-octet / ( DQUOTE *cookie-octet DQUOTE )
cookie-octet      = %x21 / %x23-2B / %x2D-3A / %x3C-5B / %x5D-7E
                      ; US-ASCII characters excluding CTLs,
                      ; whitespace DQUOTE, comma, semicolon,
                      ; and backslash
token             = <token, defined in [RFC2616], Section 2.2>

cookie-av         = expires-av / max-age-av / domain-av /
                   path-av / secure-av / httponly-av /
                    extension-av
expires-av        = "Expires=" sane-cookie-date
sane-cookie-date  = <rfc1123-date, defined in [RFC2616], Section 3.3.1>
max-age-av        = "Max-Age=" non-zero-digit *DIGIT
                      ; In practice, both expires-av and max-age-av
                      ; are limited to dates representable by the
                      ; user agent.
non-zero-digit    = %x31-39
                      ; digits 1 through 9
domain-av         = "Domain=" domain-value
domain-value      = <subdomain>
                      ; defined in [RFC1034], Section 3.5, as
                      ; enhanced by [RFC1123], Section 2.1
path-av           = "Path=" path-value
path-value        = <any CHAR except CTLs or ";">
secure-av         = "Secure"
httponly-av       = "HttpOnly"
extension-av      = <any CHAR except CTLs or ";">

Example values

• SID=31d4d96e407aad42
• lang=en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT
• lang=; Expires=Sun, 06 Nov 1994 08:49:37 GMT
• lang=en-US; Path=/; Domain=example.com

Methods

impl SetCookie

fn from_cookie_jar(jar: &CookieJar) -> SetCookie

Use this to create SetCookie header from CookieJar using calculated delta.

fn apply_to_cookie_jar(&self, jar: &mut CookieJar)

Use this on client to apply changes from SetCookie to CookieJar. Note that this will panic! if CookieJar is not root.

Trait Implementations

impl Deref for SetCookie

type Target = Vec<Cookie>

fn deref<'a>(&'a self) -> &'a Vec<Cookie>

impl DerefMut for SetCookie

fn deref_mut<'a>(&'a mut self) -> &'a mut Vec<Cookie>

impl Header for SetCookie

fn header_name() -> &'static str

fn parse_header(raw: &[Vec<u8>]) -> Option<SetCookie>

impl HeaderFormat for SetCookie

fn fmt_header(&self, f: &mut Formatter) -> Result

Derived Implementations

impl Debug for SetCookie

fn fmt(&self, __arg_0: &mut Formatter) -> Result

impl PartialEq for SetCookie

fn eq(&self, __arg_0: &SetCookie) -> bool

fn ne(&self, __arg_0: &SetCookie) -> bool

impl Clone for SetCookie

fn clone(&self) -> SetCookie

fn clone_from(&mut self, source: &Self)