Struct biscotti::RequestCookies
source · pub struct RequestCookies<'c> { /* private fields */ }
Expand description
A collection of RequestCookie
s attached to an HTTP request using the Cookie
header.
Implementations§
source§impl<'c> RequestCookies<'c>
impl<'c> RequestCookies<'c>
sourcepub fn new() -> RequestCookies<'c>
pub fn new() -> RequestCookies<'c>
Creates a new, empty RequestCookies
map.
sourcepub fn append<C>(&mut self, cookie: C) -> boolwhere
C: Into<RequestCookie<'c>>,
pub fn append<C>(&mut self, cookie: C) -> boolwhere
C: Into<RequestCookie<'c>>,
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);
sourcepub fn replace<C>(&mut self, cookie: C) -> boolwhere
C: Into<RequestCookie<'c>>,
pub fn replace<C>(&mut self, cookie: C) -> boolwhere
C: Into<RequestCookie<'c>>,
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);
sourcepub fn get(&self, name: &str) -> Option<RequestCookie<'c>>
pub fn get(&self, name: &str) -> Option<RequestCookie<'c>>
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);
sourcepub fn get_all(&self, name: &str) -> Option<CookiesForName<'_, 'c>>
pub fn get_all(&self, name: &str) -> Option<CookiesForName<'_, 'c>>
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);
sourcepub fn parse_header(
header: &'c str,
policy: &Processor
) -> Result<RequestCookies<'c>, ParseError>
pub fn parse_header( header: &'c str, policy: &Processor ) -> Result<RequestCookies<'c>, ParseError>
Parse a Cookie
header value into a RequestCookies
map.
Trait Implementations§
source§impl<'c> Clone for RequestCookies<'c>
impl<'c> Clone for RequestCookies<'c>
source§fn clone(&self) -> RequestCookies<'c>
fn clone(&self) -> RequestCookies<'c>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more