Struct CallCookies

pub struct CallCookies { /* private fields */ }

Represents HTTP cookies for an API call.

This struct manages HTTP cookies using the same ParamValue pattern as query, path, and header parameters, allowing for type-safe cookie handling with automatic OpenAPI schema generation.

Examples

use clawspec_core::CallCookies;

let cookies = CallCookies::new()
    .add_cookie("session_id", "abc123")
    .add_cookie("user_id", 12345)
    .add_cookie("preferences", "dark_mode=true");

OpenAPI Integration

Cookies are automatically documented in the OpenAPI specification with in: cookie parameter type. This follows the OpenAPI 3.1.0 specification for cookie parameters.

Implementations

impl CallCookies

pub fn new() -> Self

Creates a new empty CallCookies instance.

Examples

use clawspec_core::CallCookies;

let cookies = CallCookies::new();
assert!(cookies.is_empty());

pub fn add_cookie<T: ParameterValue>( self, name: impl Into<String>, value: impl Into<ParamValue<T>>, ) -> Self

Adds a cookie parameter to the collection.

This method follows the same pattern as CallHeaders::add_header and CallQuery::add_param, providing a consistent API across all parameter types.

Type Parameters

• T - The cookie value type, must implement Serialize, ToSchema, Debug, Send, Sync, and Clone

Arguments

• name - The cookie name (e.g., “session_id”, “user_preferences”)
• value - The cookie value, either a direct value or wrapped in ParamValue

Examples

use clawspec_core::CallCookies;

let cookies = CallCookies::new()
    .add_cookie("session_id", "abc123")
    .add_cookie("user_id", 12345)
    .add_cookie("is_admin", true);

pub fn merge(self, other: Self) -> Self

Merges another CallCookies instance into this one.

Cookies from the other instance will override cookies with the same name in this instance.

Examples

use clawspec_core::CallCookies;

let cookies1 = CallCookies::new()
    .add_cookie("session_id", "abc123");

let cookies2 = CallCookies::new()
    .add_cookie("user_id", 456);

let merged = cookies1.merge(cookies2);
assert_eq!(merged.len(), 2);

pub fn is_empty(&self) -> bool

Checks if the cookies collection is empty.

Examples

use clawspec_core::CallCookies;

let cookies = CallCookies::new();
assert!(cookies.is_empty());

let cookies = cookies.add_cookie("session_id", "abc123");
assert!(!cookies.is_empty());

pub fn len(&self) -> usize

Returns the number of cookies.

Examples

use clawspec_core::CallCookies;

let cookies = CallCookies::new()
    .add_cookie("session_id", "abc123")
    .add_cookie("user_id", 456);
assert_eq!(cookies.len(), 2);

Trait Implementations

impl Clone for CallCookies

fn clone(&self) -> CallCookies

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallCookies

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

Formats the value using the given formatter.

impl Default for CallCookies

fn default() -> CallCookies

Returns the “default value” for a type.