Struct CookieBuilder

source

pub struct CookieBuilder<'c> { /* private fields */ }

Expand description

Structure that follows the builder pattern for building Cookie structs.

To construct a cookie:

Call Cookie::build to start building.
Use any of the builder methods to set fields in the cookie.
Call CookieBuilder::finish() to retrieve the built cookie.

§Example

use cookie::Cookie;
use cookie::time::Duration;

let cookie: Cookie = Cookie::build("name", "value")
    .domain("www.rust-lang.org")
    .path("/")
    .secure(true)
    .http_only(true)
    .max_age(Duration::days(1))
    .finish();

Implementations§

source §

impl<'c> CookieBuilder<'c>

source

pub fn new<N, V>(name: N, value: V) -> CookieBuilder<'c>
where N: Into<Cow<'c, str>>, V: Into<Cow<'c, str>>,

Creates a new CookieBuilder instance from the given name and value.

This method is typically called indirectly via Cookie::build().

§Example

use cookie::Cookie;

let c = Cookie::build("foo", "bar").finish();
assert_eq!(c.name_value(), ("foo", "bar"));

source

pub fn expires<E>(self, when: E) -> CookieBuilder<'c>
where E: Into<Expiration>,

Sets the expires field in the cookie being built.

§Example

use cookie::{Cookie, Expiration};
use cookie::time::OffsetDateTime;

let c = Cookie::build("foo", "bar")
    .expires(OffsetDateTime::now_utc())
    .finish();

assert!(c.expires().is_some());

let c = Cookie::build("foo", "bar")
    .expires(None)
    .finish();

assert_eq!(c.expires(), Some(Expiration::Session));

source

pub fn max_age(self, value: Duration) -> CookieBuilder<'c>

Sets the max_age field in the cookie being built.

§Example

use cookie::Cookie;
use cookie::time::Duration;

let c = Cookie::build("foo", "bar")
    .max_age(Duration::minutes(30))
    .finish();

assert_eq!(c.max_age(), Some(Duration::seconds(30 * 60)));

source

pub fn domain<D>(self, value: D) -> CookieBuilder<'c>
where D: Into<Cow<'c, str>>,

Sets the domain field in the cookie being built.

§Example

use cookie::Cookie;

let c = Cookie::build("foo", "bar")
    .domain("www.rust-lang.org")
    .finish();

assert_eq!(c.domain(), Some("www.rust-lang.org"));

source

pub fn path(self, path: P) -> CookieBuilder<'c>
where P: Into<Cow<'c, str>>,

Sets the path field in the cookie being built.

§Example

use cookie::Cookie;

let c = Cookie::build("foo", "bar")
    .path("/")
    .finish();

assert_eq!(c.path(), Some("/"));

source

pub fn secure(self, value: bool) -> CookieBuilder<'c>

Sets the secure field in the cookie being built.

§Example

use cookie::Cookie;

let c = Cookie::build("foo", "bar")
    .secure(true)
    .finish();

assert_eq!(c.secure(), Some(true));

source

pub fn http_only(self, value: bool) -> CookieBuilder<'c>

Sets the http_only field in the cookie being built.

§Example

use cookie::Cookie;

let c = Cookie::build("foo", "bar")
    .http_only(true)
    .finish();

assert_eq!(c.http_only(), Some(true));

source

pub fn same_site(self, value: SameSite) -> CookieBuilder<'c>

Sets the same_site field in the cookie being built.

§Example

use cookie::{Cookie, SameSite};

let c = Cookie::build("foo", "bar")
    .same_site(SameSite::Strict)
    .finish();

assert_eq!(c.same_site(), Some(SameSite::Strict));

source

pub fn permanent(self) -> CookieBuilder<'c>

Makes the cookie being built ‘permanent’ by extending its expiration and max age 20 years into the future.

§Example

use cookie::Cookie;
use cookie::time::Duration;

let c = Cookie::build("foo", "bar")
    .permanent()
    .finish();

assert_eq!(c.max_age(), Some(Duration::days(365 * 20)));

source

pub fn finish(self) -> Cookie<'c>

Finishes building and returns the built Cookie.

§Example

use cookie::Cookie;

let c = Cookie::build("foo", "bar")
    .domain("crates.io")
    .path("/")
    .finish();

assert_eq!(c.name_value(), ("foo", "bar"));
assert_eq!(c.domain(), Some("crates.io"));
assert_eq!(c.path(), Some("/"));