Struct sudoku_backend::ops::setup::ActivityCache

pub struct ActivityCache { /* fields omitted */ }

A time-limited cache of session IDs for "currently active" indicator. Refer to doc/check.rs for more details.

Examples

#[get("/endpoint")]
fn endpoint(db: DatabaseConnection, ac: State<ActivityCache>) -> String {
    // Get the ID of this session
    ac.register_activity(12);

    // rest of funxionality is outside the scope of this document
    funxion_result
}

#[get("/users_active")]
fn users_active(ac: State<ActivityCache>) -> String {
    ac.active_users().to_string()
}

fn main() {
    let database_file: (String, PathBuf) = /* obtained elsewhere */;
    rocket::ignite()
        .manage(DatabaseConnection::initialise(&database_file))
        .manage(ActivityCache::new(*ACTIVITY_TIMEOUT_DEFAULT))
        .mount("/", routes![endpoint, users_active])
        .launch();
}

Methods

impl ActivityCache

pub fn new(timeout: Duration) -> ActivityCache

Create a cache timing out after the specified duration.

pub fn register_activity(&self, session_id: usize)

Mark the specified session ID as last active now.

pub fn active_users(&self) -> usize

Get how many users can be considered "active", i.e. amount of sessions last active at most the previously-specified amount of time before now.

Trait Implementations

impl Clone for ActivityCache

fn clone(&self) -> ActivityCache

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActivityCache

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

Formats the value using the given formatter.