Struct CookieBuilder

pub struct CookieBuilder { /* private fields */ }

A builder for constructing HTTP cookies with various attributes.

Implementations

impl CookieBuilder

pub fn new<N, V>(name: N, value: V) -> Self

where N: Into<CookieKey>, V: Into<CookieValue>,

Creates a new CookieBuilder with the specified name and value.

Parameters

• name: The name of the cookie.
• value: The value of the cookie.

Returns

• A new CookieBuilder instance.

pub fn parse(cookie_string: &str) -> Self

Parses a Set-Cookie header string and returns a CookieBuilder instance.

Parameters

• cookie_string: The Set-Cookie header string to parse.

Returns

• A CookieBuilder instance with parsed attributes.

pub fn expires<T>(&mut self, expires: T) -> &mut Self

where T: Into<String>,

Sets the expiration date for the cookie.

Parameters

• expires: The expiration date string (e.g., “Wed, 21 Oct 2015 07:28:00 GMT”).

Returns

• The CookieBuilder instance for method chaining.

pub fn max_age(&mut self, max_age: i64) -> &mut Self

Sets the maximum age for the cookie in seconds.

Parameters

• max_age: The maximum age in seconds.

Returns

• The CookieBuilder instance for method chaining.

pub fn domain<T>(&mut self, domain: T) -> &mut Self

where T: Into<String>,

Sets the domain for the cookie.

Parameters

• domain: The domain for the cookie.

Returns

• The CookieBuilder instance for method chaining.

pub fn path<T>(&mut self, path: T) -> &mut Self

where T: Into<String>,

Sets the path for the cookie.

Parameters

• path: The path for the cookie.

Returns

• The CookieBuilder instance for method chaining.

pub fn secure(&mut self) -> &mut Self

Sets the secure flag for the cookie.

When set to true, the cookie will only be sent over HTTPS connections.

Returns

• The CookieBuilder instance for method chaining.

pub fn http_only(&mut self) -> &mut Self

Sets the HttpOnly flag for the cookie.

When set to true, the cookie will be inaccessible to JavaScript.

Returns

• The CookieBuilder instance for method chaining.

pub fn same_site<T>(&mut self, same_site: T) -> &mut Self

where T: Into<String>,

Sets the SameSite policy for the cookie.

Parameters

• same_site: The SameSite policy (“Strict”, “Lax”, or “None”).

Returns

• The CookieBuilder instance for method chaining.

pub fn build(&self) -> String

Builds the cookie string representation.

Returns

• A formatted cookie string ready to be used in Set-Cookie headers.

Trait Implementations

impl Clone for CookieBuilder

fn clone(&self) -> CookieBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CookieBuilder

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

Formats the value using the given formatter.

impl Default for CookieBuilder

fn default() -> CookieBuilder

Returns the “default value” for a type.