Struct CookieOptions 

pub struct CookieOptions {
    pub max_age: Option<Duration>,
    pub http_only: bool,
    pub secure: bool,
    pub same_site: SameSite,
    pub path: String,
}

Configuration options for setting cookies.

The default options prioritize security:

• http_only: true — prevents JavaScript access
• secure: true — HTTPS only
• same_site: Lax — CSRF protection
• path: "/" — available to all routes

Example

use dioxus_cookie::{CookieOptions, SameSite};
use std::time::Duration;

let options = CookieOptions {
    max_age: Some(Duration::from_secs(86400 * 7)), // 7 days
    http_only: true,
    secure: true,
    same_site: SameSite::Strict,
    path: "/".to_string(),
};

Fields

max_age: Option<Duration>

Cookie lifetime. None = session cookie (deleted when browser closes).

http_only: bool

If true, cookie is inaccessible to JavaScript/WASM. Default: true.

Always use true for session tokens to prevent XSS attacks.

secure: bool

If true, cookie is only sent over HTTPS. Default: true.

same_site: SameSite

Cross-site request policy. Default: SameSite::Lax.

path: String

URL path scope for the cookie. Default: "/".

Implementations

impl CookieOptions

pub fn build_header(&self, name: &str, value: &str) -> String

Builds a Set-Cookie header string from the options.

The value is URL-encoded automatically.

Trait Implementations

impl Clone for CookieOptions

fn clone(&self) -> CookieOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CookieOptions

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

Formats the value using the given formatter.

impl Default for CookieOptions

fn default() -> Self

Returns the “default value” for a type.