Struct pomodoro::PomodoroSession

pub struct PomodoroSession<R, W> { /* fields omitted */ }

This struct represents a pomodoro session - which is from the start of running the application until you terminate it. Between that time this struct will keep track of the initial height and width of the terminal window when launching pomodoro, and keep a lock on stdin and stdout so we can draw to the screen, and also accept async input from the user. Lastly, this session also holds a state tracker, the clock itself (that gets drawn) and a config file. The config is passed in by the user. -w flag will pass in a custom work time, -s will pass in a custom short break time, and -l will pass in a custom long break time.

Methods

impl<R: Read, W: Write> PomodoroSession<R, W>

pub fn start_work(&mut self)

Call a start to a work cycle.

pub fn reset_current_pomodoro(&mut self)

Reset the current pomodoro by decrementing the cycle and re-running start_work.

pub fn countdown(&mut self)

Checks the pomodoro state (Working, ShortBreak, or LongBreak) and runs the appropraite internal countdown method.

pub fn countdown_work(&mut self)

Countdown count for work - with syncing so we are never more than a ms off from true time.

pub fn start_break(&mut self)

Starts a break by matching which break state we are in (short or long) and then running the appropriate break function.

pub fn short_break(&mut self)

Sets the break time by referencing the config (flags passed in on start) and then starts the countdown clock.

pub fn long_break(&mut self)

Sets the break time by referencing the config (flags passed in on start) and then starts the countdown clock.

pub fn countdown_break(&mut self, duration: u64)

Countdown clock for a break - extremely similar to countdown-work - separate because the notifications after the loops are different. Good place for a refactor.

pub fn draw_work_screen(&mut self)

CLOCK AND DRAWING METHODS Draws the work clock on the screen.

pub fn draw_break_screen(&mut self)

Draws the break clock on the screen.

pub fn draw_centered(&mut self, item: &str, height_offset: Option<u16>) -> usize

Takes in an input string and prints it centered on the screen Returns the last line it was printed on in case another method needs to know that to clear space after it.

pub fn draw_clock(&mut self, clock: String)

Draws the clock on the screen.

pub fn draw_work_count(&mut self)

Draws the current work count on the screen.

Example:

"Work Period 1 or 4"

pub fn draw_controls_help(&mut self)

Draws the section of the screen when the work and break clocks are rolling that actively remind user of async commands they can issue at any time to restart or quit the current cycle.

pub fn display_menu(&mut self, menu: Option<&'static str>)

Displays the pomodoro menu that is seen either at the start (large menu) or between pomodoros (small menu)

pub fn wait_for_next_command(&mut self) -> Command

WAITS (in a loop) for the next user command (happens between pomodoros).

pub fn async_command_listen(&mut self) -> Command

listens for the next command while clock is counting down in a non-blocking (async) fashion.