Struct cache::bucket::Bucket

pub struct Bucket {
    timer: u64,
    bucket_instant: u64,
    decrement: HashMap<String, u32>,
}

Fields

timer: u64

timer ID

bucket_instant: u64

instant(seconds from UNIX_EPOCH) at which time bucket begins decrement process

decrement: HashMap<String, u32>

a list of captcha keys that should be decremented during clean up

Implementations

impl Bucket

pub fn on_delete(
    ctx: &Context,
    _event_type: NotifyEvent,
    _event: &str,
    key_name: &str
)

Run when bucket timer expired at BUCKET_EXPIRY_OFFSET. Runs scheduled jobs in corresponding if they haven’t already executed

fn new(ctx: &Context, duration: u64) -> Result<Self, CacheError>

creates new bucket and sets off timer to go off at duration

fn decrement_runner(ctx: &Context, key: &RedisKeyWritable)

decrement runner that decrements all registered counts without cleaning after itself use [decrement] when you require auto cleanup. Internally, it calls this method.

fn decrement(ctx: &Context, bucket_instant: u64)

executes when timer goes off. Decrements all registered counts and cleans itself up

fn increment(ctx: &Context, captcha: &str) -> Result<String, CacheError>

increments count of key = captcha and registers for auto decrement

pub fn increment_by(
    ctx: &Context,
    (captcha_name, duration): (String, u64),
    increment_by: u32
) -> Result<(), CacheError>

open bucket, set decrement by specified number

pub fn counter_create(ctx: &Context, args: Vec<RedisString>) -> RedisResult

Create new counter

Trait Implementations

impl Clone for Bucket

fn clone(&self) -> Bucket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bucket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Bucket

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Bucket

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.