Struct timelog::logfile::Logfile

pub struct Logfile(_);

A Logfile type that wraps the timelog log file.

Implementations

impl Logfile

pub fn new(file: &str) -> Result<Self, PathError>

Creates a Logfile object wrapping the supplied file.

Errors

• Return PathError::FilenameMissing if the file has no filename.
• Return PathError::InvalidPath if the path part of file is not a valid path.

pub fn open(&self) -> Result<File, PathError>

Open the log file, return a File.

Errors

• Return PathError::FileAccess if unable to open the file.

pub fn clone_file(&self) -> String

Clone the filename

pub fn exists(&self) -> bool

Return true if the timelog file exists

pub fn add_line(&self, entry: &str) -> Result<(), PathError>

Append the supplied line (including time stamp) to the timelog file

Errors

• Return PathError::FileAccess if the file cannot be opened or created.
• Return PathError::FileWrite if the function fails to append to the file.

pub fn add_task(&self, task: &str) -> Result<(), PathError>

Append the supplied task to the timelog file

Errors

• Return PathError::FileAccess if the file cannot be opened or created.
• Return PathError::FileWrite if the function fails to append to the file.

pub fn add_entry(&self, entry: &Entry) -> Result<(), PathError>

Append the supplied Entry to the timelog file

Errors

• Return PathError::FileAccess if the file cannot be opened or created.
• Return PathError::FileWrite if the function fails to append to the file.

pub fn add_comment(&self, comment: &str) -> Result<(), PathError>

Add a comment line to the timelog file

Errors

• Return PathError::FileAccess if the file cannot be opened or created.
• Return PathError::FileWrite if the function fails to append to the file.

pub fn add_event(&self, line: &str) -> Result<(), PathError>

Add a zero duration event to the timelog file

Errors

• Return PathError::FileAccess if the file cannot be opened or created.
• Return PathError::FileWrite if the function fails to append to the file.

pub fn discard_line(&self) -> Result<(), PathError>

Remove the most recent task from the logfile.

pub fn reset_last_entry(&self) -> Result<(), Error>

Reset most recent entry to current date time.

pub fn ignore_last_entry(&self) -> Result<(), Error>

Ignore the most recent entry to current date time.

pub fn rewrite_last_entry(&self, task: &str) -> Result<(), Error>

Rewrite the text of the most recent entry.

pub fn raw_last_line(&self) -> Option<String>

Return the unfiltered last line of the timelog file or None if we can’t.

pub fn last_line(&self) -> Option<String>

Return the last line of the timelog file or None if we can’t.

pub fn last_entry(&self) -> Result<Entry, Error>

Return the last line of the timelog file as an [`Entry’].

Errors

• Return Error::InvalidEntryLine if the line is not correctly formatted.

pub fn problems(&self) -> Vec<Problem>

Return a Vec of problems found with the file.

If the Vec is empty, there are no problems.

Trait Implementations

impl Debug for Logfile

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

Formats the value using the given formatter.