Enum cookie::expiration::Expiration

source ·

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

Expand description

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§

source §

impl Expiration

source

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());

source

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());

source

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));

source

pub fn map<F>(self, f: F) -> Self
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);