Enum Expiry 

#[non_exhaustive]
pub enum Expiry {
    OnSessionEnd,
    OnInactivity(Duration),
    AtDateTime(DateTime<FixedOffset>),
}

Session expiry configuration. The Expiry attribute of a cookie determines its lifetime. When not explicitly configured, cookies default to OnSessionEnd behavior.

Examples

use std::time::Duration;

use chrono::DateTime;
use cot::config::Expiry;

// Expires when the session ends.
let expiry = Expiry::OnSessionEnd;

// Expires 5 mins after inactivity.
let expiry = Expiry::OnInactivity(Duration::from_secs(5 * 60));

// Expires at the given timestamp.
let expired_at =
    DateTime::parse_from_str("2025-05-27 13:03:00 -0200", "%Y-%m-%d %H:%M:%S %z").unwrap();
let expiry = Expiry::AtDateTime(expired_at);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OnSessionEnd

The cookie expires when the browser session ends.

This is equivalent to not setting the max-age or expires attributes in the cookie header, making it a session cookie. The cookie will be deleted when the user closes their browser or when the browser decides to end the session.

This is the most secure option as it ensures sessions don’t persist beyond the browser session, but it may require users to log in more frequently.

OnInactivity(Duration)

The cookie expires after the specified duration of inactivity.

The session will remain valid as long as the user continues to make requests within the specified time window. Each request resets the inactivity timer, extending the session lifetime.

This provides a balance between security and user convenience, as active users won’t be logged out unexpectedly, but inactive sessions will eventually expire.

AtDateTime(DateTime<FixedOffset>)

The cookie expires at the specified date and time.

The session will remain valid until the exact datetime specified, regardless of user activity.

Trait Implementations

impl Clone for Expiry

fn clone(&self) -> Expiry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Expiry

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

Formats the value using the given formatter.

impl Default for Expiry

fn default() -> Expiry

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Expiry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Expiry> for Expiry

fn from(value: Expiry) -> Self

Converts to this type from the input type.

impl Hash for Expiry

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

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 Expiry

fn eq(&self, other: &Expiry) -> 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 Serialize for Expiry

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Expiry

impl Eq for Expiry

impl StructuralPartialEq for Expiry