Struct CookieBuilder 

pub struct CookieBuilder { /* private fields */ }

Builder for constructing HTTP cookies.

Provides methods to set various cookie attributes like expiration, domain, path, and security flags before building the final cookie string.

Implementations

impl CookieBuilder

Implementation for CookieBuilder.

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

where N: AsRef<str>, V: AsRef<str>,

Creates a new cookie builder instance.

Arguments

• AsRef<str> - The cookie name type.
• AsRef<str> - The cookie value type.

Returns

• CookieBuilder - A new builder instance.

pub fn parse<C>(cookie: C) -> Self

where C: AsRef<str>,

Parses a Set-Cookie header string into a CookieBuilder.

This method takes a Set-Cookie header string and extracts the various attributes of a cookie, populating a CookieBuilder instance.

Arguments

• AsRef<str> - The Set-Cookie header string to parse.

Returns

A CookieBuilder instance populated with the parsed cookie attributes.

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

where E: AsRef<str>,

Sets the expiration date for the cookie.

Arguments

• AsRef<str> - The expiration date string.

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.

Arguments

• i64 - The maximum age in seconds.

Returns

The CookieBuilder instance for method chaining.

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

where D: AsRef<str>,

Sets the domain for the cookie.

Arguments

• AsRef<str> - The domain for the cookie.

Returns

The CookieBuilder instance for method chaining.

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

where T: AsRef<str>,

Sets the path for the cookie.

Arguments

• AsRef<str> - 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.

This flag indicates that the cookie should only be transmitted over secure (HTTPS) connections.

Returns

The CookieBuilder instance for method chaining.

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

Sets the HttpOnly flag for the cookie.

This flag prevents client-side JavaScript from accessing the cookie.

Returns

The CookieBuilder instance for method chaining.

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

where T: AsRef<str>,

Sets the SameSite policy for the cookie.

Arguments

• AsRef<str> - The SameSite policy.

Returns

The CookieBuilder instance for method chaining.

pub fn build(&self) -> String

Builds the cookie string according to the Set-Cookie header format.

Returns

• String - A formatted cookie string ready to be sent in a Set-Cookie header.

impl CookieBuilder

pub fn get_name(&self) -> &CookieKey

pub fn get_value(&self) -> &CookieValue

pub fn get_expires(&self) -> &Option<String>

pub fn get_max_age(&self) -> &Option<i64>

pub fn get_domain(&self) -> &Option<String>

pub fn get_path(&self) -> &Option<String>

pub fn get_secure(&self) -> &bool

pub fn get_http_only(&self) -> &bool

pub fn get_same_site(&self) -> &Option<String>

impl CookieBuilder

pub fn get_mut_name(&mut self) -> &mut CookieKey

pub fn get_mut_value(&mut self) -> &mut CookieValue

pub fn get_mut_expires(&mut self) -> &mut Option<String>

pub fn get_mut_max_age(&mut self) -> &mut Option<i64>

pub fn get_mut_domain(&mut self) -> &mut Option<String>

pub fn get_mut_path(&mut self) -> &mut Option<String>

pub fn get_mut_secure(&mut self) -> &mut bool

pub fn get_mut_http_only(&mut self) -> &mut bool

pub fn get_mut_same_site(&mut self) -> &mut Option<String>

impl CookieBuilder

pub fn set_name(&mut self, val: CookieKey) -> &mut Self

pub fn set_value(&mut self, val: CookieValue) -> &mut Self

pub fn set_expires(&mut self, val: Option<String>) -> &mut Self

pub fn set_max_age(&mut self, val: Option<i64>) -> &mut Self

pub fn set_domain(&mut self, val: Option<String>) -> &mut Self

pub fn set_path(&mut self, val: Option<String>) -> &mut Self

pub fn set_secure(&mut self, val: bool) -> &mut Self

pub fn set_http_only(&mut self, val: bool) -> &mut Self

pub fn set_same_site(&mut self, val: Option<String>) -> &mut Self

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.

impl PartialEq for CookieBuilder

fn eq(&self, other: &CookieBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CookieBuilder

impl StructuralPartialEq for CookieBuilder