# Trata Pomodoro Timer
### A rust based pomodoro timer library
<img src="./assets/DisplayGifOne.gif" alt="Demo on windows terminal">

## Installation
 how to install

## How To Use

You use **Trata** by first creating a config object:
```rust
 let config = Config {
        work_length_minutes: 20,
        short_break_length_minutes: 5,
        long_break_length_minutes: 30,
        has_long_break: true,
        timer_mode_will_rollover: false,
        work_sessions_before_long_break: 2,
    }
```
Here you can set the various config settings for the timer, before passing it into the `new` function in **TrataTimer**:
```rust
 let mut timer = TrataTimer::new(&config, display, timer_end_callback);
```
The **TrataTimer** must be continuously pumped in order to function:
```rust
loop {
    timer.pump_timer();
}
```

Within this loop you could also allow for control inputs in the timer [example using crossterm](examples/cli-example.rs):
```rust
fn main() {
    let config = setup_config();
    let mut timer = TrataTimer::new(&config, display, timer_end_callback);

    timer.start_timer();

    loop {
        //checks for input
        if poll(Duration::from_millis(10)).unwrap() {
            if let Ok(Event::Key(KeyEvent {
                code: KeyCode::Char(c),
                ..
            })) = event::read()
            {
                match c {
                    'q' | 'Q' => break,
                    'p' | 'P' => timer.play_pause_timer(),
                    's' | 'S' => timer.end_section_early(),
                    _ => {}
                }
            }
        } else {
        }

        //conducts timer operation (ticking, changing mode, etc)
        timer.pump_timer();
    }
}
```
Additionally, trata allows you to give feedback to the user, using a **display callback**, and a **end of timer callback**:

```rust
//display callback
fn display_callback(duration: Duration, mode: &TimerMode, timer_is_running: bool) {
    //clears the screen
    print!("\x1B[2J\x1B[1;1H");

    //formatting
    let minutes = duration.as_secs() / 60;
    let seconds = duration.as_secs() % 60;

    //prints the time remaining in seconds
    println!("{:0>2}:{:0>2}", minutes, seconds);

    if timer_is_running {
        println!("Mode: {}", mode.get_string());
    } else {
        println!("Mode: {} (Paused)", mode.get_string());
    }
    println!("Press Q to quit, S to end current timer early, & P to pause the timer.");
}


fn timer_end_callback(mode: &TimerMode) {
    //bell character
    print!("\x07");
}
```

## Contribution/Feedback
Any contributions or feedback are very welcome!

## License
[Apache 2.0](LICENSE.MD)

---
# TODO
- Crates info