Enum Expiration

pub enum Expiration {
    DateTime(OffsetDateTime),
    Session,
}

Available on crate feature cookie only.

A cookie’s expiration: either a date-time or session.

An Expiration is constructible with Expiration::from() via any of:

• None -> Expiration::Session
• Some(OffsetDateTime) -> Expiration::DateTime
• OffsetDateTime -> Expiration::DateTime

use cookie::Expiration;
use time::OffsetDateTime;

let expires = Expiration::from(None);
assert_eq!(expires, Expiration::Session);

let now = OffsetDateTime::now_utc();
let expires = Expiration::from(now);
assert_eq!(expires, Expiration::DateTime(now));

let expires = Expiration::from(Some(now));
assert_eq!(expires, Expiration::DateTime(now));

Variants

DateTime(OffsetDateTime)

Expiration for a “permanent” cookie at a specific date-time.

Session

Expiration for a “session” cookie. Browsers define the notion of a “session” and will automatically expire session cookies when they deem the “session” to be over. This is typically, but need not be, when the browser is closed.

Implementations

impl Expiration

pub fn is_datetime(&self) -> bool

Returns true if self is an Expiration::DateTime.

Example

use cookie::Expiration;
use time::OffsetDateTime;

let expires = Expiration::from(None);
assert!(!expires.is_datetime());

let expires = Expiration::from(OffsetDateTime::now_utc());
assert!(expires.is_datetime());

pub fn is_session(&self) -> bool

Returns true if self is an Expiration::Session.

Example

use cookie::Expiration;
use time::OffsetDateTime;

let expires = Expiration::from(None);
assert!(expires.is_session());

let expires = Expiration::from(OffsetDateTime::now_utc());
assert!(!expires.is_session());

pub fn datetime(self) -> Option<OffsetDateTime>

Returns the inner OffsetDateTime if self is a DateTime.

Example

use cookie::Expiration;
use time::OffsetDateTime;

let expires = Expiration::from(None);
assert!(expires.datetime().is_none());

let now = OffsetDateTime::now_utc();
let expires = Expiration::from(now);
assert_eq!(expires.datetime(), Some(now));

pub fn map<F>(self, f: F) -> Expiration

where F: FnOnce(OffsetDateTime) -> OffsetDateTime,

Applied f to the inner OffsetDateTime if self is a DateTime and returns the mapped Expiration.

Example

use cookie::Expiration;
use time::{OffsetDateTime, Duration};

let now = OffsetDateTime::now_utc();
let one_week = Duration::weeks(1);

let expires = Expiration::from(now);
assert_eq!(expires.map(|t| t + one_week).datetime(), Some(now + one_week));

let expires = Expiration::from(None);
assert_eq!(expires.map(|t| t + one_week).datetime(), None);

Trait Implementations

impl Clone for Expiration

fn clone(&self) -> Expiration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Expiration

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

Formats the value using the given formatter.

impl<T> From<T> for Expiration

where T: Into<Option<OffsetDateTime>>,

fn from(option: T) -> Expiration

Converts to this type from the input type.

impl Hash for Expiration

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Expiration

fn eq(&self, other: &Expiration) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Expiration

impl Eq for Expiration

impl StructuralPartialEq for Expiration