Struct pavex::cookie::ProcessorConfig

#[non_exhaustive]
pub struct ProcessorConfig { pub percent_encode: bool, pub crypto_rules: Vec<CryptoRule>, }
Expand description

Config specifies how the server should handle incoming and outgoing cookies with respect to security and encoding.

In particular, it specifies whether cookie values and names should be percent-encoded, and whether cookie values should be encrypted or signed.

Check out the documentation for the fields of this struct for more information.

§Processor

To action the rules specified in this struct, you must convert it into a Processor:

use biscotti::{Processor, ProcessorConfig, Key};
use biscotti::config::{CryptoRule, CryptoAlgorithm};

let mut config = ProcessorConfig::default();
config.crypto_rules.push(CryptoRule {
    cookie_names: vec!["session".to_string()],
    algorithm: CryptoAlgorithm::Encryption,
    // You'll use a key loaded from *somewhere* in production—e.g.
    // from a file, environment variable, or a secret management service.
    key: Key::generate(),
    fallbacks: vec![],
});
let processor: Processor = config.into();

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.
§percent_encode: bool

If true, all cookie values and names are automatically:

  • percent-decoded, when parsing request cookies out of the Cookie header.
  • percent-encoded, when building the Set-Cookie header from response cookies.

If false, cookie values and names are used as is.

By default, this field is true.

§crypto_rules: Vec<CryptoRule>

By default:

  • Values for response cookies are sent to the client unencrypted and unsigned
  • Values for request cookies are assumed to be unencrypted and unsigned

You can opt into higher cryptographic guarantees for specific cookies using one or more CryptoRules.

Trait Implementations§

§

impl Clone for ProcessorConfig

§

fn clone(&self) -> ProcessorConfig

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
§

impl Debug for ProcessorConfig

§

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

Formats the value using the given formatter. Read more
§

impl Default for ProcessorConfig

§

fn default() -> ProcessorConfig

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

impl<'de> Deserialize<'de> for ProcessorConfig

§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProcessorConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl From<ProcessorConfig> for Processor

§

fn from(value: ProcessorConfig) -> Processor

Converts to this type from the input type.

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,