Struct cookie::CookieBuilder

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

Structure that follows the builder pattern for building Cookie structs.

To construct a cookie:

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

Example

extern crate time;

use cookie::Cookie;
use 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

impl<'c> CookieBuilder<'c>

pub fn new<N, V>(name: N, value: V) -> Self 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"));

pub fn expires<E: Into<Expiration>>(self, when: E) -> Self

Sets the expires field in the cookie being built.

Example

extern crate time;
use time::OffsetDateTime;

use cookie::{Cookie, Expiration};

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

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

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

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

pub fn max_age(self, value: Duration) -> Self

Sets the max_age field in the cookie being built.

Example

extern crate time;
use time::Duration;

use cookie::Cookie;

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

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

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

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"));

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

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("/"));

pub fn secure(self, value: bool) -> Self

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));

pub fn http_only(self, value: bool) -> Self

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));

pub fn same_site(self, value: SameSite) -> Self

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));

pub fn permanent(self) -> Self

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

Example

extern crate time;

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

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

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

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("/"));

Trait Implementations

impl<'c> Clone for CookieBuilder<'c>

fn clone(&self) -> CookieBuilder<'c>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for CookieBuilder<'c>

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

Formats the value using the given formatter.