Struct Keeper

pub struct Keeper(/* private fields */);

Thread-safe public pointer to the KeeperData struct.

Implementations

impl Keeper

pub fn new() -> Self

Returns a Keeper instance.

Example

use celp_sdk::util::keeper::Keeper;

let keeper = Keeper::new();

pub fn wait(&self, time_ms: u64) -> Result<WaitResult, Box<dyn Error + '_>>

Wait for a set amount of milliseconds. Thread is blocked for the given amount of milliseconds.

Arguments

• time_ms - The time to wait in milliseconds.

Returns

• WaitResult on success
• A boxed Error on failure

Example

use celp_sdk::util::keeper::Keeper;

let keeper = Keeper::new();

fn execute(keeper: &Keeper) -> Result<(), Box<dyn std::error::Error>> {
    while let Ok(true) = keeper.run_loop() {
        match keeper.wait(250) {
            Ok(result) => {println!("result: {:?}", result)}
            Err(e) => {eprintln!("error: {e:#?}")}
        }
    }

    Ok(())
}

pub fn stop(&self) -> Result<(), Box<dyn Error + '_>>

Stop the thread.

Returns

• An error if the loop can’t be stopped

Example

use celp_sdk::util::keeper::Keeper;

let keeper = Keeper::new();

fn some_handler(keeper: &Keeper) {
    if let Err(e) = keeper.stop() {
        eprintln!("error: {e:#?}");
    }
}

pub fn run_loop(&self) -> Result<bool, Box<dyn Error + '_>>

Run infinite loop.

Returns

• A bool on success
• An error when the loop fails to run

Example

use celp_sdk::util::keeper::Keeper;

let keeper = Keeper::new();

fn execute(keeper: &Keeper) -> Result<(), Box<dyn std::error::Error>> {
    while let Ok(true) = keeper.run_loop() {
    }

    Ok(())
}

Trait Implementations

impl Clone for Keeper

fn clone(&self) -> Keeper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Keeper

fn default() -> Self

Returns the “default value” for a type.