Struct Processor 

pub struct Processor { /* private fields */ }

Transforms cookies before they are sent to the client, or after they have been parsed from an incoming request.

Creating a Processor

A processor is created from a ProcessorConfig using the From trait.

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();

Using a Processor

You need a Processor to invoke ResponseCookies::header_values and RequestCookies::parse_header. You can also use it to transform individual cookies using Processor::process_outgoing and Processor::process_incoming.

Implementations

impl Processor

pub fn process_outgoing<'c>( &self, cookie: ResponseCookie<'c>, ) -> ResponseCookie<'c>

Transform a ResponseCookie before it is sent to the client.

pub fn will_encrypt(&self, name: &str) -> bool

Returns true if a cookie with the given name will be encrypted before being sent back to the client in the response.

Returns false if the cookie will be signed or returned as is.

pub fn will_sign(&self, name: &str) -> bool

Returns true if a cookie with the given name will be signed before being sent back to the client in the response.

Returns false if the cookie will be encrypted or returned as is.

pub fn process_incoming<'c>( &self, name: &'c str, value: &'c str, ) -> Result<RequestCookie<'c>, ProcessIncomingError>

Transform a RequestCookie before it is added to ResponseCookies.

Trait Implementations

impl Clone for Processor

fn clone(&self) -> Processor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Processor

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

Formats the value using the given formatter.

impl From<ProcessorConfig> for Processor

fn from(value: ProcessorConfig) -> Processor

Converts to this type from the input type.