Struct cookie_store::Cookie

source ·

pub struct Cookie<'a> {
    pub path: CookiePath,
    pub domain: CookieDomain,
    pub expires: CookieExpiration,
    /* private fields */
}

Expand description

A cookie conforming more closely to IETF RFC6265

Fields

path: CookiePath

The Path attribute from a Set-Cookie header or the default-path as determined from the request-uri

domain: CookieDomain

The Domain attribute from a Set-Cookie header, or a HostOnly variant if no non-empty Domain attribute found

expires: CookieExpiration

For a persistent Cookie (see IETF RFC6265 Section 5.3), the expiration time as defined by the Max-Age or Expires attribute, otherwise SessionEnd, indicating a non-persistent Cookie that should expire at the end of the session

Implementations

source

pub fn matches(&self, request_url: &Url) -> bool

Whether this Cookie should be included for request_url

source

pub fn is_persistent(&self) -> bool

Should this Cookie be persisted across sessions?

source

pub fn expire(&mut self)

Expire this cookie

source

pub fn is_expired(&self) -> bool

Return whether the Cookie is expired now

source

pub fn expires_by(&self, utc_tm: &Tm) -> bool

Indicates if the Cookie expires as of utc_tm.

source

pub fn parse<S>(cookie_str: S, request_url: &Url) -> CookieResult<'a>where
S: Into<Cow<'a, str>>,

Parses a new user_agent::Cookie from cookie_str.

source

pub fn try_from_raw_cookie(
raw_cookie: &RawCookie<'a>,
request_url: &Url
) -> CookieResult<'a>

Create a new user_agent::Cookie from a cookie::Cookie (from the cookie crate) received from request_url.

source

pub fn into_owned(self) -> Cookie<'static>

Methods from Deref<Target = RawCookie<'a>>

source

pub fn encoded<'a>(&'a self) -> EncodedCookie<'a, 'c>

Wraps self in an EncodedCookie: a cost-free wrapper around Cookie whose Display implementation percent-encodes the name and value of the wrapped Cookie.

Example

use cookie::Cookie;

let mut c = Cookie::new("my name", "this; value?");
assert_eq!(&c.encoded().to_string(), "my%20name=this%3B%20value%3F");

source

pub fn name(&self) -> &str

Returns the name of self.

Example

use cookie::Cookie;

let c = Cookie::new("name", "value");
assert_eq!(c.name(), "name");

source

pub fn value(&self) -> &str

Returns the value of self.

Example

use cookie::Cookie;

let c = Cookie::new("name", "value");
assert_eq!(c.value(), "value");

source

pub fn name_value(&self) -> (&str, &str)

Returns the name and value of self as a tuple of (name, value).

Example

use cookie::Cookie;

let c = Cookie::new("name", "value");
assert_eq!(c.name_value(), ("name", "value"));

source

pub fn http_only(&self) -> Option<bool>

Returns whether this cookie was marked HttpOnly or not. Returns Some(true) when the cookie was explicitly set (manually or parsed) as HttpOnly, Some(false) when http_only was manually set to false, and None otherwise.

Example

use cookie::Cookie;

let c = Cookie::parse("name=value; httponly").unwrap();
assert_eq!(c.http_only(), Some(true));

let mut c = Cookie::new("name", "value");
assert_eq!(c.http_only(), None);

let mut c = Cookie::new("name", "value");
assert_eq!(c.http_only(), None);

// An explicitly set "false" value.
c.set_http_only(false);
assert_eq!(c.http_only(), Some(false));

// An explicitly set "true" value.
c.set_http_only(true);
assert_eq!(c.http_only(), Some(true));

source

pub fn secure(&self) -> Option<bool>

Returns whether this cookie was marked Secure or not. Returns Some(true) when the cookie was explicitly set (manually or parsed) as Secure, Some(false) when secure was manually set to false, and None otherwise.

Example

use cookie::Cookie;

let c = Cookie::parse("name=value; Secure").unwrap();
assert_eq!(c.secure(), Some(true));

let mut c = Cookie::parse("name=value").unwrap();
assert_eq!(c.secure(), None);

let mut c = Cookie::new("name", "value");
assert_eq!(c.secure(), None);

// An explicitly set "false" value.
c.set_secure(false);
assert_eq!(c.secure(), Some(false));

// An explicitly set "true" value.
c.set_secure(true);
assert_eq!(c.secure(), Some(true));

source

pub fn same_site(&self) -> Option<SameSite>

Returns the SameSite attribute of this cookie if one was specified.

Example

use cookie::{Cookie, SameSite};

let c = Cookie::parse("name=value; SameSite=Lax").unwrap();
assert_eq!(c.same_site(), Some(SameSite::Lax));

source

pub fn max_age(&self) -> Option<Duration>

Returns the specified max-age of the cookie if one was specified.

Example

use cookie::Cookie;

let c = Cookie::parse("name=value").unwrap();
assert_eq!(c.max_age(), None);

let c = Cookie::parse("name=value; Max-Age=3600").unwrap();
assert_eq!(c.max_age().map(|age| age.num_hours()), Some(1));

source

pub fn path(&self) -> Option<&str>

Returns the Path of the cookie if one was specified.

Example

use cookie::Cookie;

let c = Cookie::parse("name=value").unwrap();
assert_eq!(c.path(), None);

let c = Cookie::parse("name=value; Path=/").unwrap();
assert_eq!(c.path(), Some("/"));

let c = Cookie::parse("name=value; path=/sub").unwrap();
assert_eq!(c.path(), Some("/sub"));

source

pub fn domain(&self) -> Option<&str>

Returns the Domain of the cookie if one was specified.

Example

use cookie::Cookie;

let c = Cookie::parse("name=value").unwrap();
assert_eq!(c.domain(), None);

let c = Cookie::parse("name=value; Domain=crates.io").unwrap();
assert_eq!(c.domain(), Some("crates.io"));

source

pub fn expires(&self) -> Option<Tm>

Returns the Expires time of the cookie if one was specified.

Example

use cookie::Cookie;

let c = Cookie::parse("name=value").unwrap();
assert_eq!(c.expires(), None);

let expire_time = "Wed, 21 Oct 2017 07:28:00 GMT";
let cookie_str = format!("name=value; Expires={}", expire_time);
let c = Cookie::parse(cookie_str).unwrap();
assert_eq!(c.expires().map(|t| t.tm_year), Some(117));

source

pub fn name_raw(&self) -> Option<&'c str>

Returns the name of self as a string slice of the raw string self was originally parsed from. If self was not originally parsed from a raw string, returns None.

This method differs from Cookie::name() in that it returns a string with the same lifetime as the originally parsed string. This lifetime may outlive self. If a longer lifetime is not required, or you’re unsure if you need a longer lifetime, use Cookie::name().

Example

use cookie::Cookie;

let cookie_string = format!("{}={}", "foo", "bar");

// `c` will be dropped at the end of the scope, but `name` will live on
let name = {
    let c = Cookie::parse(cookie_string.as_str()).unwrap();
    c.name_raw()
};

assert_eq!(name, Some("foo"));

source

pub fn value_raw(&self) -> Option<&'c str>

Returns the value of self as a string slice of the raw string self was originally parsed from. If self was not originally parsed from a raw string, returns None.

This method differs from Cookie::value() in that it returns a string with the same lifetime as the originally parsed string. This lifetime may outlive self. If a longer lifetime is not required, or you’re unsure if you need a longer lifetime, use Cookie::value().

Example

use cookie::Cookie;

let cookie_string = format!("{}={}", "foo", "bar");

// `c` will be dropped at the end of the scope, but `value` will live on
let value = {
    let c = Cookie::parse(cookie_string.as_str()).unwrap();
    c.value_raw()
};

assert_eq!(value, Some("bar"));

source

pub fn path_raw(&self) -> Option<&'c str>

Returns the Path of self as a string slice of the raw string self was originally parsed from. If self was not originally parsed from a raw string, or if self doesn’t contain a Path, or if the Path has changed since parsing, returns None.

This method differs from Cookie::path() in that it returns a string with the same lifetime as the originally parsed string. This lifetime may outlive self. If a longer lifetime is not required, or you’re unsure if you need a longer lifetime, use Cookie::path().

Example

use cookie::Cookie;

let cookie_string = format!("{}={}; Path=/", "foo", "bar");

// `c` will be dropped at the end of the scope, but `path` will live on
let path = {
    let c = Cookie::parse(cookie_string.as_str()).unwrap();
    c.path_raw()
};

assert_eq!(path, Some("/"));

source

pub fn domain_raw(&self) -> Option<&'c str>

Returns the Domain of self as a string slice of the raw string self was originally parsed from. If self was not originally parsed from a raw string, or if self doesn’t contain a Domain, or if the Domain has changed since parsing, returns None.

This method differs from Cookie::domain() in that it returns a string with the same lifetime as the originally parsed string. This lifetime may outlive self struct. If a longer lifetime is not required, or you’re unsure if you need a longer lifetime, use Cookie::domain().

Example

use cookie::Cookie;

let cookie_string = format!("{}={}; Domain=crates.io", "foo", "bar");

//`c` will be dropped at the end of the scope, but `domain` will live on
let domain = {
    let c = Cookie::parse(cookie_string.as_str()).unwrap();
    c.domain_raw()
};

assert_eq!(domain, Some("crates.io"));

Trait Implementations

source

fn clone(&self) -> Cookie<'a>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

Formats the value using the given formatter. Read more

type Target = Cookie<'a>

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl<'a> From<Cookie<'a>> for RawCookie<'a>

source

fn from(cookie: Cookie<'a>) -> RawCookie<'static>

Converts to this type from the input type.

source

fn eq(&self, other: &Cookie<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

type Err = <U as TryFrom<T>>::Err

source

Struct cookie_store::Cookie

Fields

Implementations

impl<'a> Cookie<'a>

pub fn matches(&self, request_url: &Url) -> bool

pub fn is_persistent(&self) -> bool

pub fn expire(&mut self)

pub fn is_expired(&self) -> bool

pub fn expires_by(&self, utc_tm: &Tm) -> bool

pub fn parse<S>(cookie_str: S, request_url: &Url) -> CookieResult<'a>where S: Into<Cow<'a, str>>,

pub fn try_from_raw_cookie( raw_cookie: &RawCookie<'a>, request_url: &Url) -> CookieResult<'a>

pub fn into_owned(self) -> Cookie<'static>

Methods from Deref<Target = RawCookie<'a>>

pub fn encoded<'a>(&'a self) -> EncodedCookie<'a, 'c>

pub fn name(&self) -> &str

pub fn value(&self) -> &str

pub fn name_value(&self) -> (&str, &str)

pub fn http_only(&self) -> Option<bool>

pub fn secure(&self) -> Option<bool>

pub fn same_site(&self) -> Option<SameSite>

pub fn max_age(&self) -> Option<Duration>

pub fn path(&self) -> Option<&str>

pub fn domain(&self) -> Option<&str>

pub fn expires(&self) -> Option<Tm>

pub fn name_raw(&self) -> Option<&'c str>

pub fn value_raw(&self) -> Option<&'c str>

pub fn path_raw(&self) -> Option<&'c str>

pub fn domain_raw(&self) -> Option<&'c str>

Trait Implementations

impl<'a> Clone for Cookie<'a>

fn clone(&self) -> Cookie<'a>

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

impl<'a> Debug for Cookie<'a>

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

impl<'a> Deref for Cookie<'a>

type Target = Cookie<'a>

fn deref(&self) -> &Self::Target

impl<'de, 'a> Deserialize<'de> for Cookie<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl<'a> From<Cookie<'a>> for RawCookie<'a>

fn from(cookie: Cookie<'a>) -> RawCookie<'static>

impl<'a> PartialEq<Cookie<'a>> for Cookie<'a>

fn eq(&self, other: &Cookie<'a>) -> bool

fn ne(&self, other: &Rhs) -> bool

impl<'a> Serialize for Cookie<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

impl<'a> StructuralPartialEq for Cookie<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for Cookie<'a>

impl<'a> Send for Cookie<'a>

impl<'a> Sync for Cookie<'a>

impl<'a> Unpin for Cookie<'a>

impl<'a> UnwindSafe for Cookie<'a>

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Err = <U as TryFrom<T>>::Err

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Err>

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

pub fn parse<S>(cookie_str: S, request_url: &Url) -> CookieResult<'a>where
S: Into<Cow<'a, str>>,

pub fn try_from_raw_cookie(
raw_cookie: &RawCookie<'a>,
request_url: &Url
) -> CookieResult<'a>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,