Struct Cookie

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

Cookie header, defined in RFC6265

If the user agent does attach a Cookie header field to an HTTP request, the user agent must send the cookie-string as the value of the header field.

When the user agent generates an HTTP request, the user agent MUST NOT attach more than one Cookie header field.

Example values

• SID=31d4d96e407aad42
• SID=31d4d96e407aad42; lang=en-US

Implementations

impl Cookie

pub fn get(&self, name: &str) -> Option<&str>

Lookup a value for a cookie name.

Example

use rama_http_headers::{HeaderMapExt, Cookie};
use rama_http_types::{HeaderMap, HeaderValue};

// Setup the header map with strings...
let mut headers = HeaderMap::new();
headers.insert("cookie", HeaderValue::from_static("lang=en-US"));

// Parse a `Cookie` so we can play with it...
let cookie = headers
    .typed_get::<Cookie>()
    .expect("we just inserted a valid Cookie");

assert_eq!(cookie.get("lang"), Some("en-US"));
assert_eq!(cookie.get("SID"), None);

pub fn len(&self) -> usize

Get the number of key-value pairs this Cookie contains.

pub fn is_empty(&self) -> bool

Returns true if this doesn’t contain any cookies

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Iterator the key-value pairs of this Cookie header.

Trait Implementations

impl Clone for Cookie

fn clone(&self) -> Cookie

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cookie

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

Formats the value using the given formatter.

impl HeaderDecode for Cookie

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for Cookie

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 Cookie

fn name() -> &'static HeaderName

The name of this header.