klog

type Date interface {
	// Year returns the year as number, e.g. `2004`.
	Year() int

	// Month returns the month as number, e.g. `3` for March.
	Month() int

	// Day returns the day as number, e.g. `21`.
	Day() int

	// Weekday returns the day of the week, starting from Monday = 1.
	Weekday() int

	// Quarter returns the quarter that the date is in, e.g. `2` for `2010-04-15`.
	Quarter() int

	// WeekNumber returns the number of the week and the year that the number refers to.
	// Note: the year of the week number might be different from the year of the Date!
	WeekNumber() (int, int)

	// IsEqualTo checks whether two dates are the same.
	IsEqualTo(Date) bool

	// IsAfterOrEqual checks whether the given date occurs afterwards or at the same date.
	IsAfterOrEqual(Date) bool

	// PlusDays adds a number of days to the date. It doesn’t modify
	// the original object.
	PlusDays(int) Date

	// ToString serialises the date, e.g. `2017-04-23`.
	ToString() string

	// ToStringWithFormat serialises the date according to the given format.
	ToStringWithFormat(DateFormat) string

	// Format returns the current formatting.
	Format() DateFormat
}

type DateFormat struct {
	UseDashes bool
}

type Duration interface {
	InMinutes() int

	// Plus adds up two durations and returns a new duration.
	// It doesn’t alter the original duration object.
	Plus(Duration) Duration

	// Minus subtracts the second from the first duration.
	// It doesn’t alter the original duration object.
	Minus(Duration) Duration

	// ToString serialises the duration. If the duration is negative,
	// the value is preceded by a `-`. E.g. `45m` or `-2h15m`.
	ToString() string

	// ToStringWithSign serialises the duration. In contrast to `ToString`
	// it also precedes positive values with a `+`. If the duration is `0`,
	// no sign will be added. E.g. `-45m` or `0` or `+6h`.
	ToStringWithSign() string
}

type DurationFormat struct {
	// ForcePlus indicates whether to enforce a `+` for positive values (including 0)
	ForcePlus bool

	// ZeroSign indicates what sign a value of `0` should have:
	// `0` means no sign (default), `1` means `+`, `-1` means `-`.
	ZeroSign int
}

type Entry struct {
	// contains filtered or unexported fields
}

type EntrySummary []string

type OpenRange interface {
	Start() Time

	// ToString serialises the open range, e.g. `9:00 - ?`.
	ToString() string

	// Format returns the current formatting.
	Format() OpenRangeFormat
}

type OpenRangeFormat struct {
	UseSpacesAroundDash        bool
	AdditionalPlaceholderChars int
}

type Range interface {
	Start() Time
	End() Time
	Duration() Duration

	// ToString serialises the range, e.g. `13:15 - 17:23`.
	ToString() string

	// Format returns the current formatting.
	Format() RangeFormat
}

type RangeFormat struct {
	UseSpacesAroundDash bool
}

type Record interface {
	Date() Date

	ShouldTotal() ShouldTotal
	SetShouldTotal(Duration)

	Summary() RecordSummary
	SetSummary(RecordSummary)

	// Entries returns a list of all entries that are associated with this record.
	Entries() []Entry

	// SetEntries associates new entries with the record.
	SetEntries([]Entry)
	AddDuration(Duration, EntrySummary)
	AddRange(Range, EntrySummary)

	// OpenRange returns the open time range, or `nil` if there is none.
	OpenRange() OpenRange

	// Start starts a new open time range. It returns an error if there is
	// already an open time range present. (There can only be one per record.)
	Start(OpenRange, EntrySummary) error

	// EndOpenRange ends the open time range. It returns an error if there is
	// no open time range present, or if start and end time cannot be converted
	// into a valid time range.
	EndOpenRange(Time) error
}

type RecordSummary []string

type ShouldTotal Duration

type Tag struct {
	// contains filtered or unexported fields
}

type TagSet struct {
	// contains filtered or unexported fields
}

type Time interface {
	Hour() int
	Minute() int

	// MidnightOffset returns the duration since (positive) or until (negative) midnight.
	MidnightOffset() Duration

	// IsYesterday checks whether the time is shifted to the previous day.
	IsYesterday() bool

	// IsTomorrow checks whether the time is shifted to the next day.
	IsTomorrow() bool

	// IsToday checks whether the time is not shifted.
	IsToday() bool
	IsEqualTo(Time) bool
	IsAfterOrEqual(Time) bool

	// Plus returns a time, where the specified duration was added. It doesn’t modify
	// the original object. If the resulting time would be shifted by more than one
	// day, it returns an error.
	Plus(Duration) (Time, error)

	// ToString serialises the time, e.g. `8:00` or `23:00>`
	ToString() string

	// ToStringWithFormat serialises the date according to the given format.
	ToStringWithFormat(TimeFormat) string

	// Format returns the current formatting.
	Format() TimeFormat
}

type TimeFormat struct {
	Use24HourClock bool
}