Struct punch_clock::sheet::Sheet

pub struct Sheet {
    pub events: Vec<Event>,
}

List of events, together comprising a log of work from which totals can be calculated for various periods of time.

Fields

events: Vec<Event>

Methods

impl Sheet

pub fn load_default() -> Result<Sheet, SheetError>

Attempt to load a sheet from the file at the default location.

The default location is determined using the directories crate by platform as follows:

• Linux: $XDG_CONFIG_HOME/punchclock/sheet.json
• macOS: $HOME/Library/Application Support/dev.neros.PunchClock/sheet.json
• Windows: %APPDATA%\Local\Neros\PunchClock\sheet.json

pub fn write_default(&self) -> Result<(), SheetError>

Attempt to write a sheet to the file at the default location.

The default location is determined using the directories crate by platform as follows:

• Linux: $XDG_CONFIG_HOME/punchclock/sheet.json
• macOS: $HOME/Library/Application Support/dev.neros.PunchClock/sheet.json
• Windows: %APPDATA%\Local\Neros\PunchClock\sheet.json

pub fn punch_in(&mut self) -> Result<DateTime<Utc>, SheetError>

Record a punch-in (start of a time-tracking period) at the current time.

pub fn punch_in_at(
    &mut self,
    time: DateTime<Utc>
) -> Result<DateTime<Utc>, SheetError>

Record a punch-in (start of a time-tracking period) at the given time.

pub fn punch_out(&mut self) -> Result<DateTime<Utc>, SheetError>

Record a punch-out (end of a time-tracking period) at the current time.

pub fn punch_out_at(
    &mut self,
    time: DateTime<Utc>
) -> Result<DateTime<Utc>, SheetError>

Record a punch-out (end of a time-tracking period) at the given time.

pub fn status(&self) -> SheetStatus

Get the current status of time-tracking, including the time at which the status last changed.

pub fn count_range(&self, begin: DateTime<Utc>, end: DateTime<Utc>) -> Duration

Count the amount of time for which there was recorded work between the two given instants, including an ongoing time-tracking period if there is one.

Trait Implementations

impl Clone for Sheet

fn clone(&self) -> Sheet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sheet

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

Formats the value using the given formatter.

impl Default for Sheet

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Sheet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Sheet

impl Ord for Sheet

fn cmp(&self, other: &Sheet) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Sheet> for Sheet

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

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

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

This method tests for !=.

impl PartialOrd<Sheet> for Sheet

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

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

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

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

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

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

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

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

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

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

impl Serialize for Sheet

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Sheet

impl StructuralPartialEq for Sheet