Struct Cookies 

pub struct Cookies(/* private fields */);

The request’s cookies; what handlers set goes out with the response.

• get / set: plain values the browser can read and change.
• signed / set_signed: readable, but a changed value reads as None (HMAC-SHA256).
• encrypted / set_encrypted: hidden and tamper-proof (AES-256-GCM).

Signed and encrypted cookies use keys derived from SECRET_KEY_BASE; values made with a key of SECRET_KEY_BASE_PREVIOUS still read. Cookies Ocre sets are HttpOnly, SameSite=Lax, Path=/, and Secure over HTTPS. For per-visitor state prefer the Session, which is encrypted too; use cookies for values that outlive it or that another part of the site reads (a theme, a “remember me” token).

Free plan

Nothing billed: cookies travel with the requests.

Examples

use std::time::Duration;
use ocre::{Cookies, Result};

async fn theme(cookies: Cookies) -> Result<String> {
    let theme = cookies.get("theme").unwrap_or_else(|| "light".to_owned());
    cookies.set_signed("seen_banner", "1", Some(Duration::from_secs(30 * 86_400)))?;
    Ok(theme)
}

Implementations

impl Cookies

pub fn get(&self, name: &str) -> Option<String>

The value of the plain cookie name.

Examples

async fn theme(cookies: ocre::Cookies) -> String {
    cookies.get("theme").unwrap_or_default()
}

pub fn signed(&self, name: &str) -> Result<Option<String>>

The value of the signed cookie name; None when absent or changed by the client.

Errors

Error::Internal when SECRET_KEY_BASE is missing or shorter than 64 characters.

pub fn encrypted(&self, name: &str) -> Result<Option<String>>

The value of the encrypted cookie name; None when absent or changed by the client.

Errors

Error::Internal when SECRET_KEY_BASE is missing or shorter than 64 characters.

pub fn set( &self, name: &str, value: &str, max_age: Option<Duration>, ) -> Result<()>

Sets a plain cookie; max_age None makes it last until the browser closes.

Errors

Error::Internal for the session cookie’s name, which Ocre manages.

pub fn set_signed( &self, name: &str, value: &str, max_age: Option<Duration>, ) -> Result<()>

Sets a signed cookie: the browser sees the value, and a changed one reads as None.

Errors

Error::Internal for the session cookie’s name, or when SECRET_KEY_BASE is missing or shorter than 64 characters.

pub fn set_encrypted( &self, name: &str, value: &str, max_age: Option<Duration>, ) -> Result<()>

Sets an encrypted cookie: the browser can neither read nor change the value.

Errors

Error::Internal for the session cookie’s name, or when SECRET_KEY_BASE is missing or shorter than 64 characters.

pub fn remove(&self, name: &str)

Deletes the cookie name from the browser.

Trait Implementations

impl Clone for Cookies

fn clone(&self) -> Cookies

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Sync> FromRequestParts<S> for Cookies

type Rejection = Error

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Error>

Perform the extraction.