duration

Documentation

Overview

Package duration copied as it is from github.com/senseyeio/duration

Index

• type Duration
  • func ParseISO8601(from string) (Duration, error)
• type InfDuration
  • func (d InfDuration) Add(t time.Time) time.Time
  • func (d InfDuration) EstimateNative() (time.Duration, bool)
  • func (d InfDuration) Sub(t time.Time) time.Time
• type StandardDuration
  • func (d StandardDuration) Add(t time.Time) time.Time
  • func (d StandardDuration) EndTime(t time.Time) time.Time
  • func (d StandardDuration) EstimateNative() (time.Duration, bool)
  • func (d StandardDuration) Sub(t time.Time) time.Time
  • func (d StandardDuration) Truncate(t time.Time, firstDayOfWeek, firstMonthOfYear int) time.Time
• type TruncToDateDuration
  • func (d TruncToDateDuration) Add(t time.Time) time.Time
  • func (d TruncToDateDuration) EstimateNative() (time.Duration, bool)
  • func (d TruncToDateDuration) Sub(t time.Time) time.Time
  • func (d TruncToDateDuration) SubWithUnit(t time.Time, unit int) time.Time

Types

type Duration

type Duration interface {
	Add(t time.Time) time.Time
	Sub(t time.Time) time.Time
	EstimateNative() (time.Duration, bool)
}

func ParseISO8601

func ParseISO8601(from string) (Duration, error)

ParseISO8601 parses an ISO8601 duration as well as some Rill-specific extensions. (Section 3.7 of the standard supposedly allows extensions that do not interfere with the standard.) Current extensions are, 1. "inf" for representing an unbounded duration of time 2. X-To-Date and Previous-X duration supports with a prefix of "rill-" to DAX notations. Pulled from https://www.daxpatterns.com/standard-time-related-calculations/

type InfDuration

type InfDuration struct{}

func (InfDuration) Add

func (d InfDuration) Add(t time.Time) time.Time

func (InfDuration) EstimateNative

func (d InfDuration) EstimateNative() (time.Duration, bool)

func (InfDuration) Sub

func (d InfDuration) Sub(t time.Time) time.Time

type StandardDuration

type StandardDuration struct {
	Year   int
	Month  int
	Week   int
	Day    int
	Hour   int
	Minute int
	Second int
	// contains filtered or unexported fields
}

StandardDuration represents an ISO8601 duration with Rill-specific extensions. See ParseISO8601 for details.

func (StandardDuration) Add

func (d StandardDuration) Add(t time.Time) time.Time

Add adds the duration to a timestamp

func (StandardDuration) EndTime

func (d StandardDuration) EndTime(t time.Time) time.Time

func (StandardDuration) EstimateNative

func (d StandardDuration) EstimateNative() (time.Duration, bool)

EstimateNative estimates the duration as a native Go duration.

func (StandardDuration) Sub

func (d StandardDuration) Sub(t time.Time) time.Time

Sub subtracts the duration from a timestamp

func (StandardDuration) Truncate

func (d StandardDuration) Truncate(t time.Time, firstDayOfWeek, firstMonthOfYear int) time.Time

Truncate truncates a timestamp to the duration. It keeps the timezone of the timestamp. It only partially supports durations with multiple components (e.g. P1Y3M): it will truncate by the first component only. TODO: Is there a well-defined way to truncate by multiple components? TODO: Can this be merged with timeutil.TruncateTime? timeutil returns UTC values, whereas this returns in the same tz as the input time.

type TruncToDateDuration

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

func (TruncToDateDuration) Add

func (d TruncToDateDuration) Add(t time.Time) time.Time

func (TruncToDateDuration) EstimateNative

func (d TruncToDateDuration) EstimateNative() (time.Duration, bool)

func (TruncToDateDuration) Sub

func (d TruncToDateDuration) Sub(t time.Time) time.Time

func (TruncToDateDuration) SubWithUnit

func (d TruncToDateDuration) SubWithUnit(t time.Time, unit int) time.Time