CookieBuilder

Struct CookieBuilder 

Source
pub struct CookieBuilder { /* private fields */ }
Expand description

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§

Source§

impl CookieBuilder

Implementation for CookieBuilder.

Source

pub fn new<N, V>(name: N, value: V) -> Self
where N: Into<CookieKey>, V: Into<CookieValue>,

Creates a new cookie builder instance.

§Arguments
  • N - The cookie name type.
  • V - The cookie value type.
§Returns
  • CookieBuilder - A new builder instance.
Source

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

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
  • &str - The Set-Cookie header string to parse.
§Returns

A CookieBuilder instance populated with the parsed cookie attributes.

Source

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

Sets the expiration date for the cookie.

§Arguments
  • T - The expiration date string.
§Returns

The CookieBuilder instance for method chaining.

Source

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.

Source

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

Sets the domain for the cookie.

§Arguments
  • T - The domain for the cookie.
§Returns

The CookieBuilder instance for method chaining.

Source

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

Sets the path for the cookie.

§Arguments
  • T - The path for the cookie.
§Returns

The CookieBuilder instance for method chaining.

Source

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.

Source

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.

Source

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

Sets the SameSite policy for the cookie.

§Arguments
  • T - The SameSite policy.
§Returns

The CookieBuilder instance for method chaining.

Source

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.

Trait Implementations§

Source§

impl Clone for CookieBuilder

Source§

fn clone(&self) -> CookieBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CookieBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CookieBuilder

Source§

fn default() -> CookieBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CookieBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for CookieBuilder

Source§

impl StructuralPartialEq for CookieBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> AnySend for T
where T: Any + Send,

Source§

impl<T> AnySendClone for T
where T: Any + Send + Clone,

Source§

impl<T> AnySendSync for T
where T: Any + Send + Sync,

Source§

impl<T> AnySendSyncClone for T
where T: Any + Send + Sync + Clone,

Source§

impl<T> AnySync for T
where T: Any + Sync,

Source§

impl<T> AnySyncClone for T
where T: Any + Sync + Clone,

Source§

impl<T> ErasedDestructor for T
where T: 'static,