Struct SetCookie 

pub struct SetCookie(/* private fields */);

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

Example

Implementations

impl SetCookie

pub fn iter_header_values(&self) -> impl Iterator<Item = &HeaderValue>

Trait Implementations

impl Clone for SetCookie

fn clone(&self) -> SetCookie

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetCookie

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl HeaderDecode for SetCookie

fn decode<'i, I>(values: &mut I) -> Result<SetCookie, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for SetCookie

fn encode<E>(&self, values: &mut E)

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> HeaderValue

Encode this header to HeaderValue.

impl TypedHeader for SetCookie

fn name() -> &'static HeaderName

The name of this header.