Struct Cookie

pub struct Cookie<'a> { /* private fields */ }

Represents an HTTP cookie, including attributes such as domain, path, and expiration.

Implementations

impl<'a> Cookie<'a>

pub fn parse<V: Into<Cow<'a, str>>>(value: V) -> Result<Self, ParseError>

Parses a cookie from a string in a lenient mode.

In lenient mode, unknown attributes are ignored.

Arguments

• value: The string representation of the cookie.

Returns

A Result containing the parsed Cookie or a ParseError.

Example

use cookie_rs::prelude::*;

let cookie = Cookie::parse("session=abc123; Secure").unwrap();
assert_eq!(cookie.name(), "session");
assert_eq!(cookie.value(), "abc123");
assert_eq!(cookie.secure(), Some(true));

pub fn parse_strict<V: Into<Cow<'a, str>>>(value: V) -> Result<Self, ParseError>

Parses a cookie from a string in a strict mode.

In strict mode, unknown attributes cause an error.

Arguments

• value: The string representation of the cookie.

Returns

A Result containing the parsed Cookie or a ParseError.

Example

use cookie_rs::prelude::*;

let result = Cookie::parse_strict("session=abc123; UnknownAttr");
assert!(result.is_err());

impl<'a> Cookie<'a>

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

where N: Into<Cow<'a, str>>, V: Into<Cow<'a, str>>,

Creates a new Cookie with the specified name and value.

Arguments

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

Example

use cookie_rs::prelude::*;

let cookie = Cookie::new("session", "abc123");
assert_eq!(cookie.name(), "session");
assert_eq!(cookie.value(), "abc123");

pub fn builder<N, V>(name: N, value: V) -> CookieBuilder<'a>

where N: Into<Cow<'a, str>>, V: Into<Cow<'a, str>>,

Creates a CookieBuilder for constructing a Cookie with additional attributes.

Arguments

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

Example

use cookie_rs::prelude::*;

let cookie = Cookie::builder("session", "abc123")
    .domain("example.com")
    .secure(true)
    .build();

pub fn set_domain<V: Into<Cow<'a, str>>>(&mut self, domain: V)

Sets the domain for the cookie.

Arguments

• domain: The domain attribute of the cookie.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_domain("example.com");
assert_eq!(cookie.domain(), Some("example.com"));

pub fn set_expires<V: Into<Cow<'a, str>>>(&mut self, expires: V)

Sets the expiration date for the cookie.

Arguments

• expires: The expiration date of the cookie.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_expires("Wed, 21 Oct 2025 07:28:00 GMT");
assert_eq!(cookie.expires(), Some("Wed, 21 Oct 2025 07:28:00 GMT"));

pub fn set_http_only(&mut self, http_only: bool)

Sets the HttpOnly attribute for the cookie.

Arguments

• http_only: Whether the cookie is HttpOnly.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_http_only(true);
assert_eq!(cookie.http_only(), Some(true));

pub fn set_max_age<V: Into<Duration>>(&mut self, max_age: V)

Sets the maximum age for the cookie.

Arguments

• max_age: The maximum age of the cookie as a Duration.

Example

use std::time::Duration;
use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_max_age(Duration::from_secs(3600));
assert_eq!(cookie.max_age(), Some(Duration::from_secs(3600)));

pub fn set_partitioned(&mut self, partitioned: bool)

Sets the partitioned attribute for the cookie.

Arguments

• partitioned: Whether the cookie is partitioned.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_partitioned(true);
assert_eq!(cookie.partitioned(), Some(true));

pub fn set_path<V: Into<Cow<'a, str>>>(&mut self, path: V)

Sets the path attribute for the cookie.

Arguments

• path: The path attribute of the cookie.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_path("/");
assert_eq!(cookie.path(), Some("/"));

pub fn set_same_site(&mut self, same_site: SameSite)

Sets the SameSite attribute for the cookie.

Arguments

• same_site: The SameSite attribute for the cookie.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_same_site(SameSite::Lax);
assert_eq!(cookie.same_site(), Some(SameSite::Lax));

pub fn set_secure(&mut self, secure: bool)

Sets the Secure attribute for the cookie.

Arguments

• secure: Whether the cookie is secure.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_secure(true);
assert_eq!(cookie.secure(), Some(true));

pub fn name(&self) -> &str

Returns the name of the cookie.

Example

use cookie_rs::prelude::*;

let cookie = Cookie::new("session", "abc123");
assert_eq!(cookie.name(), "session");

pub fn value(&self) -> &str

Returns the value of the cookie.

Example

use cookie_rs::prelude::*;

let cookie = Cookie::new("session", "abc123");
assert_eq!(cookie.value(), "abc123");

pub fn domain(&self) -> Option<&str>

Returns the domain of the cookie, if set.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_domain("example.com");
assert_eq!(cookie.domain(), Some("example.com"));

pub fn expires(&self) -> Option<&str>

Returns the expiration date of the cookie, if set.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_expires("Wed, 21 Oct 2025 07:28:00 GMT");
assert_eq!(cookie.expires(), Some("Wed, 21 Oct 2025 07:28:00 GMT"));

pub fn http_only(&self) -> Option<bool>

Returns whether the cookie has the HttpOnly attribute set.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_http_only(true);
assert_eq!(cookie.http_only(), Some(true));

pub fn max_age(&self) -> Option<Duration>

Returns the maximum age of the cookie, if set.

Example

use std::time::Duration;
use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_max_age(Duration::from_secs(3600));
assert_eq!(cookie.max_age(), Some(Duration::from_secs(3600)));

pub fn partitioned(&self) -> Option<bool>

Returns whether the cookie is partitioned.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_partitioned(true);
assert_eq!(cookie.partitioned(), Some(true));

pub fn path(&self) -> Option<&str>

Returns the path of the cookie, if set.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_path("/");
assert_eq!(cookie.path(), Some("/"));

pub fn same_site(&self) -> Option<SameSite>

Returns the SameSite attribute of the cookie, if set.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_same_site(SameSite::Lax);
assert_eq!(cookie.same_site(), Some(SameSite::Lax));

pub fn secure(&self) -> Option<bool>

Returns whether the cookie has the Secure attribute set.

Example

use cookie_rs::prelude::*;

let mut cookie = Cookie::new("session", "abc123");
cookie.set_secure(true);
assert_eq!(cookie.secure(), Some(true));

Trait Implementations

impl<'a> Borrow<str> for Cookie<'a>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'a> Clone for Cookie<'a>

fn clone(&self) -> Cookie<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Cookie<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Cookie<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for Cookie<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for Cookie<'a>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<(&'a str, &'a str)> for Cookie<'a>

fn from(value: (&'a str, &'a str)) -> Self

Converts to this type from the input type.

impl<'a> FromStr for Cookie<'a>

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a> Ord for Cookie<'a>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Cookie<'a>

fn eq(&self, other: &Self) -> 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<'a> PartialOrd for Cookie<'a>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for Cookie<'a>