Struct countrs::Counter

pub struct Counter<T> {
    pub start: T,
    pub end: T,
    pub direction: Direction,
}

A counter stores start and end times, and implements Display to either show the time passed since start, or until end, formatted as HH(+):MM:SS.
The timer will not go down past 00:00:00.

Examples

Basic functionality is very simple:

let now = TimeStamp::now();
let mut counter = Counter::down(
    Some(now - 600),
    Some(now + 600)
);

// A small amount of time will have passed since `now` was assigned
assert_eq!(counter.to_string(), "00:09:59");
counter.flip();
// It now counts up from `start`
assert_eq!(counter.to_string(), "00:10:00")

Both start and end times are adjustable:

let mut counter = Counter::up(Some(TimeStamp::now()), None);
counter.try_move_start(-30).unwrap();

assert_eq!(counter.to_string(), "00:00:30")

Fields

start: T

end: T

direction: Direction

Implementations

impl<T, D> Counter<T>where T: Copy + Default + Display + Time<Duration = D> + FromStr + Sub<T, Output = D>, D: TimeUnits,

pub fn down(start: Option<T>, end: Option<T>) -> Counter<T>

If given None, the default value for T will be assigned.

pub fn up(start: Option<T>, end: Option<T>) -> Counter<T>

If given None, the default value for T will be assigned.

pub fn to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Calls to_string on start, end, and direction, and std::fs::writes each to one line in a file, in that order.

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Counter<T>>

Tries converting the first three lines of a file (read by std::fs::read_to_string) into a Counter by attempting to parse them into start, end, and direction respectively, calling from_str.

pub fn flip(&mut self)

Changes the direction of the Counter between Up/Down.

pub fn try_move_start( &mut self, seconds: impl Into<D> ) -> Result<(), TimeOverflow>

pub fn try_move_end( &mut self, seconds: impl Into<D> ) -> Result<(), TimeOverflow>

Trait Implementations

impl<T: Debug> Debug for Counter<T>

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

Formats the value using the given formatter.

impl<T, D> Display for Counter<T>where T: Copy + Default + Display + Time<Duration = D> + FromStr + Sub<T, Output = D>, D: TimeUnits,

Displayed as “HH(+):MM:SS”, not below “00:00:00”

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

Formats the value using the given formatter.

impl<T: Ord> Ord for Counter<T>

fn cmp(&self, other: &Counter<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Counter<T>> for Counter<T>

fn eq(&self, other: &Counter<T>) -> 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<T: PartialOrd> PartialOrd<Counter<T>> for Counter<T>

fn partial_cmp(&self, other: &Counter<T>) -> 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<T: Eq> Eq for Counter<T>

impl<T> StructuralEq for Counter<T>

impl<T> StructuralPartialEq for Counter<T>