Enum pace_core::StorageKind

pub enum StorageKind {
    ActivityStore(ActivityStore),
    InMemoryActivityStorage(InMemoryActivityStorage),
    TomlActivityStorage(TomlActivityStorage),
}

Variants

ActivityStore(ActivityStore)

InMemoryActivityStorage(InMemoryActivityStorage)

TomlActivityStorage(TomlActivityStorage)

Trait Implementations

impl ActivityQuerying for StorageKind

fn group_activities_by_duration_range( &self ) -> PaceOptResult<BTreeMap<PaceDurationRange, Vec<ActivityItem>>>

Group activities by predefined duration ranges (e.g., short, medium, long).

This is useful for analyzing how time is spent on different activities.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities that are grouped by their duration range. The key is the duration range, and the value is a list of activities that fall within that range. If no activities are found, it should return Ok(None).

fn group_activities_by_start_date( &self ) -> PaceOptResult<BTreeMap<PaceDate, Vec<ActivityItem>>>

Group activities by their start date. This can help in analyzing how activities are distributed over time.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities that are grouped by their start date. The key is the start date of the activity, and the value is a list of activities that started on that date.

fn list_activities_with_intermissions( &self ) -> PaceOptResult<BTreeMap<ActivityGuid, Vec<ActivityItem>>>

Retrieve activities that have one or more intermissions, useful for identifying potential inefficiencies or breaks.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities that have intermissions. The key is the ID of the activity, and the value is a list of intermissions. If no activities are found, it should return Ok(None).

fn group_activities_by_keywords( &self, __enum_dispatch_arg_0: KeywordOptions ) -> PaceOptResult<BTreeMap<String, Vec<ActivityItem>>>

Group activities based on keywords, e.g., category, tags, etc.

This is useful for analyzing time spent on different projects or areas of work.

Arguments

• keyword_opts - The keyword options to filter the activities by.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities that are matching the KeywordOptions. The key is the keyword, and the value is a list of matching activities. If no activities are found, it should return Ok(None).

fn group_activities_by_kind( &self ) -> PaceOptResult<BTreeMap<ActivityKind, Vec<ActivityItem>>>

Group activities based on their kind (e.g., Task, Intermission).

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities with their kind. The key is the kind of the activity, and the value is a list of activities of that kind. If no activities are found, it should return Ok(None).

fn list_activities_by_time_range( &self, __enum_dispatch_arg_0: TimeRangeOptions ) -> PaceOptResult<Vec<ActivityItem>>

List activities by time range from the storage backend.

Arguments

• time_range_opts - The range options to filter the activities by.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities that are matching the RangeOptions. If no activities are found, it should return Ok(None).

fn group_activities_by_status( &self ) -> PaceOptResult<BTreeMap<ActivityStatus, Vec<ActivityItem>>>

Group activities by their status from the storage backend.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities by their status. If no activities are found, it should return Ok(None).

fn list_current_activities( &self, __enum_dispatch_arg_0: ActivityStatusFilter ) -> PaceOptResult<Vec<ActivityGuid>>

List all current activities from the storage backend matching an ActivityFilter.

Errors

This function should return an error if the activities cannot be loaded. In case of no activities, it should return Ok(None).

Returns

A collection of the activities that are matching the ActivityFilter.

fn list_activities_by_id( &self ) -> PaceOptResult<BTreeMap<ActivityGuid, Activity>>

Get all activities by their ID.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities that were loaded from the storage backend by their ID in a BTreeMap. If no activities are found, it should return Ok(None).

fn list_active_intermissions(&self) -> PaceOptResult<Vec<ActivityGuid>>

List all active intermissions from the storage backend.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities that are currently active intermissions. If no activities are found, it should return Ok(None).

fn list_most_recent_activities( &self, __enum_dispatch_arg_0: usize ) -> PaceOptResult<Vec<ActivityGuid>>

List the most recent activities from the storage backend.

Arguments

• count - The number of activities to list.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the most recent activities. If no activities are found, it should return Ok(None).

fn is_activity_active( &self, __enum_dispatch_arg_0: ActivityGuid ) -> PaceResult<bool>

Check if an activity is currently active.

Arguments

• activity_id - The ID of the activity to check.

Errors

This function should return an error if the activity cannot be checked.

Returns

If the activity is active, it should return Ok(true). If it is not active, it should return Ok(false).

fn list_active_intermissions_for_activity_id( &self, __enum_dispatch_arg_0: ActivityGuid ) -> PaceOptResult<Vec<ActivityGuid>>

Check if an activity currently has one or more active intermissions.

Arguments

• activity_id - The ID of the activity to check.

Errors

This function should return an error if the activity cannot be checked.

Returns

If the activity has active intermissions, it should return Ok(Option<VecDeque<ActivityGuid>>) with the IDs of the active intermissions. If it has no active intermissions, it should return Ok(None).

fn most_recent_active_activity(&self) -> PaceOptResult<ActivityItem>

Get the latest active activity.

Errors

This function should return an error if the activity cannot be loaded.

Returns

The latest active activity. If no activity is found, it should return Ok(None).

fn most_recent_held_activity(&self) -> PaceOptResult<ActivityItem>

Get the latest held activity.

Errors

This function should return an error if the activity cannot be loaded.

Returns

The latest held activity. If no activity is found, it should return Ok(None).

impl ActivityReadOps for StorageKind

fn read_activity( &self, __enum_dispatch_arg_0: ActivityGuid ) -> PaceResult<ActivityItem>

Read an activity from the storage backend.

Arguments

• activity_id - The ID of the activity to read.

Errors

This function should return an error if the activity cannot be read.

Returns

The activity that was read from the storage backend. If no activity is found, it should return Ok(None).

fn list_activities( &self, __enum_dispatch_arg_0: ActivityStatusFilter ) -> PaceOptResult<FilteredActivities>

List activities from the storage backend.

Arguments

• filter - The filter to apply to the activities.

Errors

This function should return an error if the activities cannot be loaded.

Returns

A collection of the activities that were loaded from the storage backend. Returns Ok(None) if no activities are found.

impl ActivityStateManagement for StorageKind

fn begin_activity( &self, __enum_dispatch_arg_0: Activity ) -> PaceResult<ActivityItem>

Begin an activity in the storage backend. This makes the activity active.

Arguments

• activity - The activity to start.

Errors

This function should return an error if the activity cannot be started.

Returns

If the activity was started successfully it should return the ID of the started activity.

fn hold_activity( &self, __enum_dispatch_arg_0: ActivityGuid, __enum_dispatch_arg_1: HoldOptions ) -> PaceResult<ActivityItem>

Hold an activity in the storage backend.

Arguments

• activity_id - The ID of the activity to hold.
• hold_opts - The options to hold the activity.

Errors

This function should return an error if the activity cannot be held.

Returns

If the activity was held successfully it should return the ActivityItem of the held activity.

fn resume_activity( &self, __enum_dispatch_arg_0: ActivityGuid, __enum_dispatch_arg_1: ResumeOptions ) -> PaceResult<ActivityItem>

Resume an activity in the storage backend.

Arguments

• activity_id - The ID of the activity to resume. If None, the last unfinished activity is resumed.
• resume_time - The time (HH:MM) to resume the activity at. If None, the current time is used.

Errors

This function should return an error if the activity cannot be resumed.

Returns

The activity that was resumed. Returns Ok(None) if no activity was resumed.

fn resume_most_recent_activity( &self, __enum_dispatch_arg_0: ResumeOptions ) -> PaceOptResult<ActivityItem>

Resume the most recent activity in the storage backend.

Arguments

• resume_opts - The options to resume the activity.

Errors

This function should return an error if the activity cannot be resumed.

Returns

The activity that was resumed. Returns Ok(None) if no activity was resumed.

fn end_activity( &self, __enum_dispatch_arg_0: ActivityGuid, __enum_dispatch_arg_1: EndOptions ) -> PaceResult<ActivityItem>

End an activity in the storage backend.

Arguments

• activity_id - The ID of the activity to end.
• end_opts - The options to end the activity.

Errors

This function should return an error if the activity cannot be ended.

Returns

If the activity was ended successfully it should return the ID of the ended activity.

fn end_all_unfinished_activities( &self, __enum_dispatch_arg_0: EndOptions ) -> PaceOptResult<Vec<ActivityItem>>

End all unfinished activities in the storage backend.

Arguments

• end_opts - The options to end the activities.

Errors

This function should return an error if the activities cannot be ended.

Returns

A collection of the activities that were ended. Returns Ok(None) if no activities were ended.

fn end_all_active_intermissions( &self, __enum_dispatch_arg_0: EndOptions ) -> PaceOptResult<Vec<ActivityGuid>>

End all active intermissions in the storage backend.

Arguments

• end_opts - The options to end the intermissions.

Errors

This function should return an error if the intermissions cannot be ended.

Returns

A collection of the intermissions that were ended. Returns Ok(None) if no intermissions were ended.

fn end_last_unfinished_activity( &self, __enum_dispatch_arg_0: EndOptions ) -> PaceOptResult<ActivityItem>

End the last unfinished activity in the storage backend.

Arguments

• end_opts - The options to end the activity.

Errors

This function should return an error if the activity cannot be ended.

Returns

The activity that was ended. Returns Ok(None) if no activity was ended.

fn hold_most_recent_active_activity( &self, __enum_dispatch_arg_0: HoldOptions ) -> PaceOptResult<ActivityItem>

Hold the most recent activity that is active in the storage backend.

Arguments

• hold_opts - The options to hold the activity.

Errors

This function should return an error if the activity cannot be held or if there are no activities to hold.

Returns

The activity that was held if there was an unfinished activity to hold. If there are no activities to hold, it should return Ok(None).

Note

This function should not be used to hold an activity that is already held. It should only be used to hold the last unfinished activity.

impl ActivityStorage for StorageKind

fn setup_storage(&self) -> PaceResult<()>

Setup the storage backend. This is called once when the application starts.

This is where you would create the database tables, open the file, etc.

Errors

This function should return an error if the storage backend cannot be setup.

impl ActivityWriteOps for StorageKind

fn create_activity( &self, __enum_dispatch_arg_0: Activity ) -> PaceResult<ActivityItem>

Create an activity in the storage backend.

Arguments

• activity - The activity to create.

Errors

This function should return an error if the activity cannot be created.

Returns

If the activity was created successfully it should return the ID of the created activity.

fn update_activity( &self, __enum_dispatch_arg_0: ActivityGuid, __enum_dispatch_arg_1: Activity, __enum_dispatch_arg_2: UpdateOptions ) -> PaceResult<ActivityItem>

Update an existing activity in the storage backend.

Note

This function should not be used to update the state of an activity (e.g., start, end, hold, resume) directly. Use the ActivityStateManagement trait for that. This function is only for updating (as in replacing) the complete data of an activity.

Warning: It can’t be used to update the ID of an activity, because that’s the primary key. So it is immutable.

Arguments

• activity_id - The ID of the activity to update.
• activity - The updated activity data.

Errors

This function should return an error if the activity cannot be updated.

Returns

If the activity was updated successfully it should return the original activity before it was updated.

fn delete_activity( &self, __enum_dispatch_arg_0: ActivityGuid, __enum_dispatch_arg_1: DeleteOptions ) -> PaceResult<ActivityItem>

Delete an activity from the storage backend.

Arguments

• activity_id - The ID of the activity to delete.

Errors

This function should return an error if the activity cannot be deleted.

Returns

If the activity was deleted successfully it should return the activity that was deleted.

impl From<ActivityStore> for StorageKind

fn from(v: ActivityStore) -> StorageKind

Converts to this type from the input type.

impl From<InMemoryActivityStorage> for StorageKind

fn from(v: InMemoryActivityStorage) -> StorageKind

Converts to this type from the input type.

impl From<TomlActivityStorage> for StorageKind

fn from(v: TomlActivityStorage) -> StorageKind

Converts to this type from the input type.

impl SyncStorage for StorageKind

fn sync(&self) -> PaceResult<()>

Sync the storage to a persistent medium.

Errors

This function should return an error if the storage cannot be synced.

Returns

If the storage was synced successfully it should return Ok(()).

impl TryInto<ActivityStore> for StorageKind

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<ActivityStore, <Self as TryInto<ActivityStore>>::Error>

Performs the conversion.

impl TryInto<InMemoryActivityStorage> for StorageKind

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<InMemoryActivityStorage, <Self as TryInto<InMemoryActivityStorage>>::Error>

Performs the conversion.

impl TryInto<TomlActivityStorage> for StorageKind

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<TomlActivityStorage, <Self as TryInto<TomlActivityStorage>>::Error>

Performs the conversion.