Struct poem::web::cookie::CookieJar

source ·

pub struct CookieJar { /* private fields */ }

Available on crate feature cookie only.

Expand description

A collection of cookies that tracks its modifications.

§Example

use poem::{
    get, handler,
    http::{header, StatusCode},
    middleware::CookieJarManager,
    test::TestClient,
    web::cookie::{Cookie, CookieJar},
    Endpoint, EndpointExt, Request, Route,
};

#[handler]
fn index(cookie_jar: &CookieJar) -> String {
    let count = match cookie_jar.get("count") {
        Some(cookie) => cookie.value::<i32>().unwrap() + 1,
        None => 1,
    };
    cookie_jar.add(Cookie::new("count", count));
    format!("count: {}", count)
}

let app = Route::new()
    .at("/", get(index))
    .with(CookieJarManager::new());
let cli = TestClient::new(app);

let resp = cli.get("/").send().await;
resp.assert_status_is_ok();
let cookie = resp.0.headers().get(header::SET_COOKIE).cloned().unwrap();
resp.assert_text("count: 1").await;

let resp = cli.get("/").header(header::COOKIE, cookie).send().await;
resp.assert_status_is_ok();
resp.assert_text("count: 2").await;

Implementations§

source §

impl CookieJar

source

pub fn add(&self, cookie: Cookie)

Adds cookie to this jar. If a cookie with the same name already exists, it is replaced with cookie.

source

pub fn remove(&self, name: impl AsRef<str>)

Removes cookie from this jar.

source

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

Returns a reference to the Cookie inside this jar with the name. If no such cookie exists, returns None.

source

pub fn reset_delta(&self)

Removes all delta cookies.

source

pub fn with_cookies<F, R>(&self, f: F) -> R
where F: FnOnce(Iter<'_>) -> R,

Wraps an iterator over all of the cookies present in this jar with a closure.

source

pub fn private_with_key<'a>( &'a self, key: &'a CookieKey ) -> PrivateCookieJar<'a>

Returns a PrivateJar with self as its parent jar using the key to encrypt and decrypt cookies added/retrieved from the child jar.

§Example

use poem::web::cookie::{Cookie, CookieJar, CookieKey};

let key = CookieKey::generate();
let cookie_jar = CookieJar::default();

cookie_jar
    .private_with_key(&key)
    .add(Cookie::new_with_str("foo", "bar"));

assert_ne!(cookie_jar.get("foo").unwrap().value_str(), "bar");
assert_eq!(
    cookie_jar
        .private_with_key(&key)
        .get("foo")
        .unwrap()
        .value_str(),
    "bar"
);

let key2 = CookieKey::generate();
assert!(cookie_jar.private_with_key(&key2).get("foo").is_none());

source

pub fn private(&self) -> PrivateCookieJar<'_>

Similar to the private_with_key function, but using the key specified by the CookieJarManager::with_key.

source

pub fn signed_with_key<'a>(&'a self, key: &'a CookieKey) -> SignedCookieJar<'a>

Returns a SignedJar with self as its parent jar using the key key to verify cookies retrieved from the child jar. Any retrievals from the child jar will be made from the parent jar.

§Example

use poem::web::cookie::{Cookie, CookieJar, CookieKey};

let key = CookieKey::generate();
let cookie_jar = CookieJar::default();

cookie_jar
    .signed_with_key(&key)
    .add(Cookie::new_with_str("foo", "bar"));

assert!(cookie_jar.get("foo").unwrap().value_str().contains("bar"));
assert_eq!(
    cookie_jar
        .signed_with_key(&key)
        .get("foo")
        .unwrap()
        .value_str(),
    "bar"
);

let key2 = CookieKey::generate();
assert!(cookie_jar.signed_with_key(&key2).get("foo").is_none());