Struct RequestCookies

pub struct RequestCookies<'cookie> { /* private fields */ }

A collection of RequestCookies attached to an HTTP request using the Cookie header.

Implementations

impl<'cookie> RequestCookies<'cookie>

pub fn new() -> RequestCookies<'cookie>

Creates a new, empty RequestCookies map.

pub fn append<C>(&mut self, cookie: C) -> bool

where C: Into<RequestCookie<'cookie>>,

Inserts a new RequestCookie into self.

If a cookie with the same name already exists, the new value is appended to the existing value list.

If you want to replace the existing value list for a given name, use the RequestCookies::replace() method.

Return value

Returns true if RequestCookies contained one or more cookies with the same name. false otherwise.

Example

use biscotti::{RequestCookie, RequestCookies};

let mut cookies = RequestCookies::new();
cookies.append(RequestCookie::new("name", "value1"));
assert_eq!(cookies.get("name").unwrap().value(), "value1");

// A new cookie with the same name: its value is appended to
// the existing value list for `name`.
cookies.append(RequestCookie::new("name", "value2"));
// `get` keeps returning the first value.
assert_eq!(cookies.get("name").unwrap().value(), "value1");
// Use `get_all` to get all values for a given name.
let mut c = cookies.get_all("name").unwrap();
assert_eq!(c.next().unwrap().value(), "value1");
assert_eq!(c.next().unwrap().value(), "value2");
assert_eq!(c.next(), None);

pub fn replace<C>(&mut self, cookie: C) -> bool

where C: Into<RequestCookie<'cookie>>,

Inserts a new RequestCookie into self.

If a cookie with the same name already exists, the existing value list is discarded and replaced with the new value.

If you want to append a new value to the existing value list, use RequestCookies::append().

Return value

Returns true if RequestCookies contained one or more cookies with the same name. false otherwise.

Example

use biscotti::{RequestCookie, RequestCookies};

let mut cookies = RequestCookies::new();
cookies.replace(RequestCookie::new("name", "value1"));

assert_eq!(cookies.get("name").unwrap().value(), "value1");

// A new cookie with the same name: its value replaces
// the existing value list for `name`.
cookies.replace(RequestCookie::new("name", "value2"));

assert_eq!(cookies.get("name").unwrap().value(), "value2");
let mut values = cookies.get_all("name").unwrap().values();
assert_eq!(values.next(), Some("value2"));
assert_eq!(values.next(), None);

pub fn get<'map, 'key>( &'map self, name: &'key str, ) -> Option<RequestCookie<'cookie>>

Get a cookie by name.

If there are multiple cookie values associated to the name, this method returns the first one. If you want to get all cookie values for a given name, use RequestCookies::get_all().

Example

use biscotti::{RequestCookie, RequestCookies};

let mut cookies = RequestCookies::new();
cookies.append(RequestCookie::new("name", "value1"));
assert_eq!(cookies.get("name").unwrap().value(), "value1");

// A new cookie with the same name: its value is appended to
// the existing value list for `name`.
cookies.append(RequestCookie::new("name", "value2"));

// `get` keeps returning the first value.
assert_eq!(cookies.get("name").unwrap().value(), "value1");
// `get_all` returns all values.
let mut values = cookies.get_all("name").unwrap().values();
assert_eq!(values.next(), Some("value1"));
assert_eq!(values.next(), Some("value2"));
assert_eq!(values.next(), None);

pub fn get_all<'map, 'key>( &'map self, name: &'key str, ) -> Option<CookiesForName<'map, 'cookie>>

Get all cookie values for a given cookie name.
If there are no cookies with the given name, the method returns None.

If you want to get the first cookie value for a given name, use the RequestCookies::get() method.

Example

use biscotti::{RequestCookie, RequestCookies};

let mut cookies = RequestCookies::new();
cookies.append(RequestCookie::new("name", "value1"));
assert_eq!(cookies.get("name").unwrap().value(), "value1");

// A new cookie with the same name: its value is appended to
// the existing value list for `name`.
cookies.append(RequestCookie::new("name", "value2"));

// `get` keeps returning the first value.
assert_eq!(cookies.get("name").unwrap().value(), "value1");
// `get_all` returns all values.
let mut values = cookies.get_all("name").unwrap().values();
assert_eq!(values.next(), Some("value1"));
assert_eq!(values.next(), Some("value2"));
assert_eq!(values.next(), None);

pub fn parse_header( header: &'cookie str, processor: &Processor, ) -> Result<RequestCookies<'cookie>, ParseError>

Parse a Cookie header value into a RequestCookies map.

pub fn extend_from_header( &mut self, header: &'cookie str, processor: &Processor, ) -> Result<(), ParseError>

Parse a Cookie header value and append its value to the existing RequestCookies map.

pub fn parse_headers<I>( headers: I, processor: &Processor, ) -> Result<RequestCookies<'cookie>, ParseError>

where I: IntoIterator<Item = &'cookie str>,

Parse multiple Cookie header values into a RequestCookies map.

Trait Implementations

impl<'cookie> Clone for RequestCookies<'cookie>

fn clone(&self) -> RequestCookies<'cookie>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'cookie> Debug for RequestCookies<'cookie>

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

Formats the value using the given formatter.

impl<'cookie> Default for RequestCookies<'cookie>

fn default() -> RequestCookies<'cookie>

Returns the “default value” for a type.