Struct pavex::cookie::CookieKit

source ·
#[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>, }
Expand description

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)§

This struct is marked as 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§

source§

impl CookieKit

source

pub fn new() -> Self

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

source

pub fn with_default_processor_config(self) -> Self

Set the ProcessorConfig constructor to ProcessorConfig::default.

source

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§

source§

impl Clone for CookieKit

source§

fn clone(&self) -> CookieKit

Returns a copy 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 CookieKit

source§

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

Formats the value using the given formatter. Read more

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, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

source§

type Output = T

Should always be Self
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more