Struct climer::timer::Timer

pub struct Timer {
    pub running: bool,
    pub finished: bool,
    // some fields omitted
}

Fields

running: bool

finished: bool

Methods

impl Timer

pub fn builder() -> TimerBuilder

Returns a new TimerBuilder.

pub fn new<T, U>(
    time: T,
    format: Option<U>,
    output: Option<Output>
) -> ClimerResult<Self> where
    T: ToString,
    U: ToString, 

Create a new Timer with the given time (string) and optional format (string) and output (Output).

pub fn run(&mut self) -> ClimerResult

Run the timer. This will lock the current thread until the time is up. If you want to update the timer yourself somewhere else, then don't call this method, instead call the update method to update the timer.

pub fn start(&mut self) -> ClimerResult

Start the timer. Do not call this method directly if you are using the run method. Only call this method if you intend to update the timer manually by calling the update method.

pub fn stop(&mut self) -> ClimerResult

Stops the timer, after it has been started using the start method.

pub fn update(&mut self) -> ClimerResult

Updates the timer. This will also attempt to write the remaining time to stdout or to a file, using the Output of this Timer.

pub fn time_output(&self) -> Time

Returns a Time with the passed time since the timer started.