Struct pace_core::Activity

impl Activity

pub fn builder() -> ActivityBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building Activity. On the builder, call .category(...)(optional), .description(...), .begin(...)(optional), .activity_end_options(...)(optional), .kind(...)(optional), .activity_kind_options(...)(optional), .pomodoro_cycle_options(...)(optional), .status(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Activity.

impl Activity

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

The category of the activity

pub fn description(&self) -> &String

The description of the activity

pub fn begin(&self) -> &PaceDateTime

The start date and time of the activity

pub fn activity_end_options(&self) -> &Option<ActivityEndOptions>

pub fn kind(&self) -> &ActivityKind

The kind of activity

pub fn activity_kind_options(&self) -> &Option<ActivityKindOptions>

Optional attributes for the activity kind

pub fn pomodoro_cycle_options(&self) -> &Option<PomodoroCycle>

The pomodoro cycle of the activity

pub fn status(&self) -> &ActivityStatus

impl Activity

pub fn set_category(&mut self, val: Option<String>) -> &mut Self

The category of the activity

pub fn set_description(&mut self, val: String) -> &mut Self

The description of the activity

pub fn set_begin(&mut self, val: PaceDateTime) -> &mut Self

The start date and time of the activity

pub fn set_activity_end_options( &mut self, val: Option<ActivityEndOptions> ) -> &mut Self

pub fn set_kind(&mut self, val: ActivityKind) -> &mut Self

The kind of activity

pub fn set_activity_kind_options( &mut self, val: Option<ActivityKindOptions> ) -> &mut Self

Optional attributes for the activity kind

pub fn set_pomodoro_cycle_options( &mut self, val: Option<PomodoroCycle> ) -> &mut Self

The pomodoro cycle of the activity

pub fn set_status(&mut self, val: ActivityStatus) -> &mut Self

impl Activity

pub fn category_mut(&mut self) -> &mut Option<String>

The category of the activity

pub fn description_mut(&mut self) -> &mut String

The description of the activity

pub fn begin_mut(&mut self) -> &mut PaceDateTime

The start date and time of the activity

pub fn activity_end_options_mut(&mut self) -> &mut Option<ActivityEndOptions>

pub fn kind_mut(&mut self) -> &mut ActivityKind

The kind of activity

pub fn activity_kind_options_mut(&mut self) -> &mut Option<ActivityKindOptions>

Optional attributes for the activity kind

pub fn pomodoro_cycle_options_mut(&mut self) -> &mut Option<PomodoroCycle>

The pomodoro cycle of the activity

pub fn status_mut(&mut self) -> &mut ActivityStatus

impl Activity

pub fn new_from_self(&self) -> Self

Create a new activity from this activity to resume an already ended/archived/etc. activity

pub fn is_held(&self) -> bool

If the activity is held

pub fn is_active(&self) -> bool

If the activity is active, so if it is currently being tracked Intermissions are not considered active activities, please use [is_active_intermission] for that

pub fn make_active(&mut self)

Make the activity active

pub fn make_inactive(&mut self)

Make the activity inactive

pub fn archive(&mut self)

Archive the activity This is only possible if the activity is not active and has ended

pub fn unarchive(&mut self)

Unarchive the activity This is only possible if the activity is archived

pub fn is_active_intermission(&self) -> bool

If the activity is an active intermission

pub fn is_archived(&self) -> bool

If the activity is archived

pub fn is_inactive(&self) -> bool

If the activity is inactive

pub fn has_ended(&self) -> bool

If the activity has ended and is not archived

pub fn end_activity(&mut self, end_opts: ActivityEndOptions)

End the activity

§Arguments

end - The end date and time of the activity
duration - The PaceDuration of the activity

pub fn end_activity_with_duration_calc( &mut self, begin: PaceDateTime, end: PaceDateTime ) -> PaceResult<()>

End the activity with a given end date and time

§Arguments

begin - The begin date and time of the activity (for calculating the duration)
end - The end date and time of the activity

§Errors

Returns an error if the duration cannot be calculated

§Returns

Returns Ok(()) if the activity is ended successfully

pub fn parent_id(&self) -> Option<ActivityGuid>

Get parent_id if activity is intermission

§Returns

Some(ActivityGuid) - The parent_id of the activity
None - If the activity is not an intermission

Trait Implementations§

impl Clone for Activity

fn clone(&self) -> Activity

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Activity

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

Formats the value using the given formatter. Read more

impl Default for Activity

fn default() -> Activity

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Activity

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for Activity

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

Formats the value using the given formatter. Read more

impl From<Activity> for ActivityItem

fn from(activity: Activity) -> Self

Converts to this type from the input type.

impl Merge for Activity

fn merge(&mut self, other: Self)

Merge another object into this object.

impl PartialEq for Activity

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

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

1.0.0 · source§

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 Serialize for Activity

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

Serialize this value into the given Serde serializer. Read more

impl Eq for Activity

impl StructuralPartialEq for Activity

Auto Trait Implementations§

impl UnwindSafe for Activity

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text italicized

fn blink(&self) -> BlinkDisplay<'_, Self>

Make the text blink

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

Make the text blink (but fast!)

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more