Struct Controller

pub struct Controller<T: Store, B: MessageBody = BoxBody> { /* private fields */ }

Implementations

impl<T: Store, B: MessageBody> Controller<T, B>

pub fn new() -> Self

Create a default Controller, with all functions as None

pub fn with_do_rate_limit(self, f: fn(&HttpRequest) -> bool) -> Self

Determine if a request needs to be checked for rate limiting. If not set, all requests will be checked.

pub fn with_find_identifier(self, f: fn(&HttpRequest) -> T::Key) -> Self

Extract the identifier from the request, such as the IP address or other information.

pub fn on_rate_limit_error( self, f: fn(&HttpRequest, Error) -> HttpResponse<B>, ) -> Self

Set the HttpResponse<B> to be returned when a rate-limit error occurs.

pub fn on_store_error( self, f: fn(&HttpRequest, <T as Store>::Error) -> HttpResponse<B>, ) -> Self

Set the HttpResponse<B> to be returned when an error occurs in the Store (such as Redis or other storage structures).

pub fn on_success(self, f: fn(&HttpRequest, &T, Option<&T::Value>)) -> Self

Execute this function whenever a request successfully passes (including those skipped by Self::fn_do_rate_limit).

Trait Implementations

impl<T: Clone + Store, B: Clone + MessageBody> Clone for Controller<T, B>

where T::Key: Clone, T::Value: Clone,

fn clone(&self) -> Controller<T, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Default for Controller<T, BoxBody>

where T: Store<Key = String> + 'static,

fn default() -> Self

alias of Self::new, but use default functions.