Struct surf_cookie_middleware::CookieStore

pub struct CookieStore { /* fields omitted */ }

Implementations

impl CookieStore

pub fn get_request_cookies(
    &self,
    url: &Url
) -> impl Iterator<Item = &Cookie<'static>>

Return an Iterator of the cookies for url in the store

pub fn store_response_cookies<I>(&mut self, cookies: I, url: &Url) where
    I: Iterator<Item = Cookie<'static>>, 

Store the cookies received from url

pub fn with_suffix_list(self, psl: List) -> CookieStore

Specify a publicsuffix::List for the CookieStore to allow public suffix matching

pub fn contains(&self, domain: &str, path: &str, name: &str) -> bool

Returns true if the CookieStore contains an unexpired Cookie corresponding to the specified domain, path, and name.

pub fn contains_any(&self, domain: &str, path: &str, name: &str) -> bool

Returns true if the CookieStore contains any (even an expired) Cookie corresponding to the specified domain, path, and name.

pub fn get(&self, domain: &str, path: &str, name: &str) -> Option<&Cookie<'_>>

Returns a reference to the unexpired Cookie corresponding to the specified domain, path, and name.

pub fn get_any(
    &self,
    domain: &str,
    path: &str,
    name: &str
) -> Option<&Cookie<'static>>

Returns a reference to the (possibly expired) Cookie corresponding to the specified domain, path, and name.

pub fn remove(
    &mut self,
    domain: &str,
    path: &str,
    name: &str
) -> Option<Cookie<'static>>

Removes a Cookie from the store, returning the Cookie if it was in the store

pub fn matches(&self, request_url: &Url) -> Vec<&Cookie<'static>>

Returns a collection of references to unexpired cookies that path- and domain-match request_url, as well as having HttpOnly and Secure attributes compatible with the request_url.

pub fn parse(
    &mut self,
    cookie_str: &str,
    request_url: &Url
) -> Result<StoreAction, Error>

Parses a new Cookie from cookie_str and inserts it into the store.

pub fn insert_raw(
    &mut self,
    cookie: &Cookie<'_>,
    request_url: &Url
) -> Result<StoreAction, Error>

Converts a cookie::Cookie (from the cookie crate) into a cookie_store::Cookie and inserts it into the store.

pub fn insert(
    &mut self,
    cookie: Cookie<'static>,
    request_url: &Url
) -> Result<StoreAction, Error>

Inserts cookie, received from request_url, into the store, following the rules of the IETF RFC6265 Storage Model. If the Cookie is unexpired and is successfully inserted, returns Ok(StoreAction::Inserted). If the Cookie is expired and matches an existing Cookie in the store, the existing Cookie wil be expired() and Ok(StoreAction::ExpiredExisting) will be returned.

pub fn clear(&mut self)

Clear the contents of the store

pub fn iter_unexpired(
    &'a self
) -> impl Iterator<Item = &'a Cookie<'static>> + 'a

An iterator visiting all the unexpired cookies in the store

pub fn iter_any(&'a self) -> impl Iterator<Item = &'a Cookie<'static>> + 'a

An iterator visiting all (including expired) cookies in the store

pub fn save<W, E, F>(
    &self,
    writer: &mut W,
    cookie_to_string: F
) -> Result<(), Box<dyn Error + 'static + Sync + Send>> where
    F: Fn(&Cookie<'static>) -> Result<String, E>,
    W: Write,
    Box<dyn Error + 'static + Sync + Send>: From<E>, 

Serialize any unexpired and persistent cookies in the store with cookie_to_string and write them to writer

pub fn save_json<W>(
    &self,
    writer: &mut W
) -> Result<(), Box<dyn Error + 'static + Sync + Send>> where
    W: Write, 

Serialize any unexpired and persistent cookies in the store to JSON format and write them to writer

pub fn load<R, E, F>(
    reader: R,
    cookie_from_str: F
) -> Result<CookieStore, Box<dyn Error + 'static + Sync + Send>> where
    F: Fn(&str) -> Result<Cookie<'static>, E>,
    R: BufRead,
    Box<dyn Error + 'static + Sync + Send>: From<E>, 

Load cookies from reader, deserializing with cookie_from_str, skipping any expired cookies

pub fn load_json<R>(
    reader: R
) -> Result<CookieStore, Box<dyn Error + 'static + Sync + Send>> where
    R: BufRead, 

Load JSON-formatted cookies from reader, skipping any expired cookies

Trait Implementations

impl Debug for CookieStore

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

Formats the value using the given formatter.

impl Default for CookieStore

pub fn default() -> CookieStore

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for CookieStore

pub fn deserialize<D>(
    deserializer: D
) -> Result<CookieStore, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for CookieStore

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.