use std::borrow::Cow; use crate::{Cookie, SameSite, Expiration}; /// 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 /// /// ```rust /// # extern crate cookie; /// use cookie::Cookie; /// use cookie::time::Duration; /// /// # fn main() { /// let cookie: Cookie = Cookie::build("name", "value") /// .domain("www.rust-lang.org") /// .path("/") /// .secure(true) /// .http_only(true) /// .max_age(Duration::days(1)) /// .finish(); /// # } /// ``` #[derive(Debug, Clone)] pub struct CookieBuilder<'c> { /// The cookie being built. cookie: Cookie<'c>, } impl<'c> CookieBuilder<'c> { /// Creates a new `CookieBuilder` instance from the given name and value. /// /// This method is typically called indirectly via [`Cookie::build()`]. /// /// # Example /// /// ```rust /// use cookie::Cookie; /// /// let c = Cookie::build("foo", "bar").finish(); /// assert_eq!(c.name_value(), ("foo", "bar")); /// ``` pub fn new(name: N, value: V) -> Self where N: Into>, V: Into> { CookieBuilder { cookie: Cookie::new(name, value) } } /// Sets the `expires` field in the cookie being built. /// /// # Example /// /// ```rust /// # extern crate cookie; /// use cookie::{Cookie, Expiration}; /// use cookie::time::OffsetDateTime; /// /// # fn main() { /// 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)); /// # } /// ``` #[inline] pub fn expires>(mut self, when: E) -> Self { self.cookie.set_expires(when); self } /// Sets the `max_age` field in the cookie being built. /// /// # Example /// /// ```rust /// # extern crate cookie; /// use cookie::Cookie; /// use cookie::time::Duration; /// /// # fn main() { /// let c = Cookie::build("foo", "bar") /// .max_age(Duration::minutes(30)) /// .finish(); /// /// assert_eq!(c.max_age(), Some(Duration::seconds(30 * 60))); /// # } /// ``` #[inline] pub fn max_age(mut self, value: time::Duration) -> Self { self.cookie.set_max_age(value); self } /// Sets the `domain` field in the cookie being built. /// /// # Example /// /// ```rust /// 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 domain>>(mut self, value: D) -> Self { self.cookie.set_domain(value); self } /// Sets the `path` field in the cookie being built. /// /// # Example /// /// ```rust /// use cookie::Cookie; /// /// let c = Cookie::build("foo", "bar") /// .path("/") /// .finish(); /// /// assert_eq!(c.path(), Some("/")); /// ``` pub fn path>>(mut self, path: P) -> Self { self.cookie.set_path(path); self } /// Sets the `secure` field in the cookie being built. /// /// # Example /// /// ```rust /// use cookie::Cookie; /// /// let c = Cookie::build("foo", "bar") /// .secure(true) /// .finish(); /// /// assert_eq!(c.secure(), Some(true)); /// ``` #[inline] pub fn secure(mut self, value: bool) -> Self { self.cookie.set_secure(value); self } /// Sets the `http_only` field in the cookie being built. /// /// # Example /// /// ```rust /// use cookie::Cookie; /// /// let c = Cookie::build("foo", "bar") /// .http_only(true) /// .finish(); /// /// assert_eq!(c.http_only(), Some(true)); /// ``` #[inline] pub fn http_only(mut self, value: bool) -> Self { self.cookie.set_http_only(value); self } /// Sets the `same_site` field in the cookie being built. /// /// # Example /// /// ```rust /// use cookie::{Cookie, SameSite}; /// /// let c = Cookie::build("foo", "bar") /// .same_site(SameSite::Strict) /// .finish(); /// /// assert_eq!(c.same_site(), Some(SameSite::Strict)); /// ``` #[inline] pub fn same_site(mut self, value: SameSite) -> Self { self.cookie.set_same_site(value); self } /// Makes the cookie being built 'permanent' by extending its expiration and /// max age 20 years into the future. /// /// # Example /// /// ```rust /// # extern crate cookie; /// use cookie::Cookie; /// use cookie::time::Duration; /// /// # fn main() { /// let c = Cookie::build("foo", "bar") /// .permanent() /// .finish(); /// /// assert_eq!(c.max_age(), Some(Duration::days(365 * 20))); /// # assert!(c.expires().is_some()); /// # } /// ``` #[inline] pub fn permanent(mut self) -> Self { self.cookie.make_permanent(); self } /// Finishes building and returns the built `Cookie`. /// /// # Example /// /// ```rust /// 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("/")); /// ``` #[inline] pub fn finish(self) -> Cookie<'c> { self.cookie } }