Struct libnotcurses_sys::examples::utils::Counter

pub struct Counter {
    pub starting: isize,
    pub current: isize,
    pub step: isize,
    pub limit: Option<isize>,
}

A little versatile Counter.

Fields

starting: isize

The starting value.

current: isize

The current value.

step: isize

The amount to increase the current value on each update, until it reaches its limit.

limit: Option<isize>

An optional limit value that, when reached, will prevent further updating the counter.

If set, it must have the same sign as the step. If not set, the natural limit will be |isize::MAX|.

Implementations

impl Counter

pub fn new(value: isize, step: isize, limit: Option<isize>) -> Self

Returns a new Counter.

Note that limit and step must be both positive or negative together.

pub fn update(&mut self) -> bool

If a limit value has been set, returns true when the counter has reached its limit value, and if not, increments its current value.

If there’s no limit value, always returns false while incrementing the current value.

pub fn wrapping_update(&mut self) -> bool

Like update but wraps the value if it reaches the limit.

pub fn is_done(&self) -> bool

Returns true if the counter has reached its limit value.

When there’s no limit, it will always return false.

pub fn reset(&mut self) -> isize

Returns the current value, and sets it at the starting value.

Trait Implementations

impl Debug for Counter

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

Formats the value using the given formatter.

impl Display for Counter

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

Formats the value using the given formatter.