Struct pavex::cookie::CookieKit

#[non_exhaustive]
pub struct CookieKit {
    pub request_cookies: Option<Constructor>,
    pub response_cookies: Option<Constructor>,
    pub processor: Option<Constructor>,
    pub processor_config: Option<Constructor>,
    pub response_cookie_injector: Option<PostProcessingMiddleware>,
}

A collection of components required to work with request and response cookies.

Guide

Check out the cookie installation section of Pavex’s guide for a thorough introduction to cookies and how to customize them.

Example

use pavex::blueprint::Blueprint;
use pavex::cookie::CookieKit;

let mut bp = Blueprint::new();
let kit = CookieKit::new().register(&mut bp);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

request_cookies: Option<Constructor>

The constructor for RequestCookies.

By default, it uses extract_request_cookies. The error is handled by ExtractRequestCookiesError::into_response.

response_cookies: Option<Constructor>

The constructor for ResponseCookies.

By default, it uses ResponseCookies::new.

processor: Option<Constructor>

The constructor for Processor.

By default, it uses Processor::from

processor_config: Option<Constructor>

The constructor for ProcessorConfig.

By default, it’s None. You can use with_default_processor_config to set it ProcessorConfig::default.

response_cookie_injector: Option<PostProcessingMiddleware>

A post-processing middleware to inject response cookies into the outgoing response via the Set-Cookie header.

By default, it’s set to inject_response_cookies. The error is handled by InjectResponseCookiesError::into_response.

Implementations

impl CookieKit

pub fn new() -> Self

Create a new CookieKit with all the bundled constructors and middlewares.

pub fn with_default_processor_config(self) -> Self

Set the ProcessorConfig constructor to ProcessorConfig::default.

pub fn register(self, bp: &mut Blueprint) -> RegisteredCookieKit

Register all the bundled constructors and middlewares with a Blueprint.

If a component is set to None it will not be registered.

Trait Implementations

impl Clone for CookieKit

fn clone(&self) -> CookieKit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CookieKit

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

Formats the value using the given formatter.