Struct abar::StatusBlock

pub struct StatusBlock { /* fields omitted */ }

Encapsulates a Fn() -> String closure.

Each StatusBlock has a unique name, some command that returns a string, and a polling interval. The result of the command will be cached, and will be updated iff the update() method is called and the time since the last update is > the polling interval.

Building

StatusBlocks follow the builder pattern for instantiation, so to make a new one you might use something like this:

let block = StatusBlock::new()
    .name("example")
    .command(&|| "hello".to_string())
    .poll_interval(Duration::from_secs(5));

Implementations

impl StatusBlock

pub fn new() -> Self

Returns a new StatusBlock with default values. The defaults are:

StatusBlock {
    name:          String::new(),
    command:       Box::new(|| String::new()),
    poll_interval: None,
}

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

pub fn command(self, command: &'static dyn Fn() -> String) -> Self

pub fn poll_interval(self, poll_interval: Duration) -> Self

pub fn get_name(&self) -> &str

Returns a reference to the name of the StatusBlock.

pub fn get_cache(&self) -> &String

Returns a reference to the StatusBlocks’s cache.

pub fn update(&mut self)

Iff the StatusBlock needs to be updated, update it.