Struct timelog::entry::Entry

pub struct Entry { /* private fields */ }

Representation of an entry in the log

Objects of this type represent individual lines in the timelog.txt file. Each Entry has a date and time stamp, an optional project, and a task.

Implementations

impl Entry

Line parsing tools

pub fn task_breakdown(entry_text: &str) -> (Option<String>, Option<String>)

Parse the entry line text into the task name and detail parts if they exist.

pub fn is_stop_line(line: &str) -> bool

Return true if the supplied string looks like a stop line.

pub fn datetime_from_line(line: &str) -> Option<&str>

Extract a date/time string from a task line

pub fn date_from_line(line: &str) -> Option<&str>

Extract a date string from a task line

pub fn extract_year(line: &str) -> Option<i32>

Return the year for the supplied entry line, if any.

pub fn is_comment_line(line: &str) -> bool

Return true if the supplied line is a comment.

impl Entry

Constructors

pub fn new(entry_text: &str, time: DateTime) -> Self

Create a new Entry representing the supplied task at the supplied time.

pub fn new_marked(entry_text: &str, time: DateTime, kind: EntryKind) -> Self

Create a new Entry representing the supplied task at the supplied time and optional mark.

pub fn new_stop(time: DateTime) -> Self

Create a new Entry representing a stop entry for the supplied DateTime

pub fn from_line(line: &str) -> Result<Self, EntryError>

Create a new Entry representing the entry from the supplied line.

This entry must be formatted as described in Format.md.

Errors

Return an EntryError if the line is empty or formatted incorrectly.

impl Entry

Accessors

pub fn project(&self) -> Option<&str>

Return the &str designated as the project, if any, from the Entry.

pub fn entry_text(&self) -> &str

Return the &str containing all of the Entry except the time and date.

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

Return the String containing all of the Entry except the time and date.

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

Return the String containing all of the Entry except the time and date.

pub fn task_and_detail(&self) -> (Option<String>, Option<String>)

Return the String containing all of the Entry except the time and date.

pub fn epoch(&self) -> i64

Return the time for the start of the Entry in epoch seconds.

pub fn date(&self) -> Date

Return the date for the start of the Entry as a Date

pub fn date_time(&self) -> DateTime

Return the time for the start of the Entry as a DateTime

pub fn timestamp(&self) -> String

Return the time for the start of the Entry as a DateTime

pub fn stamp(&self) -> String

Return the date stamp of the Entry in ‘YYYY-MM-DD’ format.

pub fn is_start(&self) -> bool

Return true if this a start Entry.

pub fn is_stop(&self) -> bool

Return true if this was a stop Entry.

pub fn is_ignore(&self) -> bool

Return true if this was an ignored Entry.

pub fn ignore(&self) -> Self

Return an ignored Entry converted from this one.

pub fn is_event(&self) -> bool

Return true if this was a event Entry.

impl Entry

Mutators

pub fn change_date_time(&self, date_time: DateTime) -> Self

Return a new copy of the current Entry with the date and time reset the the supplied value.

pub fn change_text(&self, task: &str) -> Self

Return a new copy of the current Entry with the date and time reset the the supplied value.

pub fn to_day_end(&self) -> Self

Return a new Entry timestamped as the end of this date

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.

impl Display for Entry

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

Format the Entry formatted as described in Format.md.

impl PartialEq<Entry> for Entry

fn eq(&self, other: &Entry) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Entry> for Entry

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Entry

impl StructuralEq for Entry

impl StructuralPartialEq for Entry