Struct Recorder 

pub struct Recorder { /* private fields */ }

What: The steps of one add, filled as the add runs and written when it ends. Why: The accounting is separate from the clock so that the controls can drive it with chosen times.

In TS you’d write (pseudocode):

type Recorder = { commonDir: string; open: Frame[]; spent: Spent[]; notes: [string, string][] };

Implementations

impl Recorder

pub fn new(common_dir: PathBuf) -> Self

A recorder for an add in the repository whose common Git directory is common_dir.

pub fn enter(&mut self, name: &str, at: Duration)

Enter the step name at at, a time since the recorder began.

pub fn leave(&mut self, at: Duration)

Leave the innermost step at at; its own time is what the steps inside it left, and the outer step loses the whole.

pub fn note(&mut self, key: &str, value: &str)

Note a fact about the add; a later note of the same key replaces the earlier one.

pub fn add_work(&mut self, name: &str, own: Duration)

Add own to the work named name, as one call.

pub fn line(&self, total: Duration, exit_code: i32) -> String

The record as one line of JSON ending in a newline; total is the add’s whole time.

One write per line keeps the lines of concurrent adds from interleaving; a word with a quote or a newline is escaped by quote, so the line stays one line.

pub fn common_dir(&self) -> &Path

The directory that holds the record’s file.

Trait Implementations

impl Debug for Recorder

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

Formats the value using the given formatter.