1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
use std::borrow::Cow; use time::{Tm, Duration}; use ::Cookie; /// Structure that follows the builder pattern for building `Cookie` structs. /// /// To construct a cookie: /// /// 1. Call [Cookie::build](struct.Cookie.html#method.build) to start building. /// 2. Use any of the builder methods to set fields in the cookie. /// 3. Call [finish](#method.finish) to retrieve the built cookie. /// /// # Example /// /// ```rust /// # extern crate cookie; /// extern crate time; /// /// use cookie::Cookie; /// use 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 { /// The cookie being built. cookie: Cookie<'static>, } impl CookieBuilder { /// Creates a new `CookieBuilder` instance from the given name and value. /// /// This method is typically called indirectly via /// [Cookie::build](struct.Cookie.html#method.build). /// /// # Example /// /// ```rust /// use cookie::Cookie; /// /// let c = Cookie::build("foo", "bar").finish(); /// assert_eq!(c.name_value(), ("foo", "bar")); /// ``` pub fn new<N, V>(name: N, value: V) -> CookieBuilder where N: Into<Cow<'static, str>>, V: Into<Cow<'static, str>> { CookieBuilder { cookie: Cookie::new(name, value) } } /// Sets the `expires` field in the cookie being built. /// /// # Example /// /// ```rust /// # extern crate cookie; /// extern crate time; /// /// use cookie::Cookie; /// /// # fn main() { /// let c = Cookie::build("foo", "bar") /// .expires(time::now()) /// .finish(); /// /// assert!(c.expires().is_some()); /// # } /// ``` #[inline] pub fn expires(mut self, when: Tm) -> CookieBuilder { self.cookie.set_expires(when); self } /// Sets the `max_age` field in the cookie being built. /// /// # Example /// /// ```rust /// # extern crate cookie; /// extern crate time; /// use time::Duration; /// /// use cookie::Cookie; /// /// # 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: Duration) -> CookieBuilder { 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<D: Into<Cow<'static, str>>>(mut self, value: D) -> CookieBuilder { 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<P: Into<Cow<'static, str>>>(mut self, path: P) -> CookieBuilder { 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(), true); /// ``` #[inline] pub fn secure(mut self, value: bool) -> CookieBuilder { 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(), true); /// ``` #[inline] pub fn http_only(mut self, value: bool) -> CookieBuilder { self.cookie.set_http_only(value); 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<'static> { self.cookie } }