compensation

Documentation

Index

• type Period
  • func PeriodFromString(s string) (Period, error)
  • func PeriodFromTime(t time.Time) Period
  • func (p Period) EndDateExclusive() time.Time
  • func (p Period) MarshalCSV() (string, error)
  • func (p Period) StartDate() time.Time
  • func (p Period) String() string
  • func (p *Period) UnmarshalCSV(s string) error

Types

type Period

type Period struct {
	Year  int
	Month time.Month
}

Period represents a monthly payment period.

func PeriodFromString

func PeriodFromString(s string) (Period, error)

PeriodFromString parses the YYYY-MM string into a Period.

func PeriodFromTime

func PeriodFromTime(t time.Time) Period

PeriodFromTime takes a time.Time and returns a Period that contains it.

func (Period) EndDateExclusive

func (p Period) EndDateExclusive() time.Time

EndDateExclusive returns a time.Time that is greater than any time in the period.

func (Period) MarshalCSV

func (p Period) MarshalCSV() (string, error)

MarshalCSV returns the CSV form of the Period.

func (Period) StartDate

func (p Period) StartDate() time.Time

StartDate returns a time.Time that is less than or equal to any time in the period.

func (Period) String

func (p Period) String() string

String outputs the YYYY-MM form of the payment period.

func (*Period) UnmarshalCSV

func (p *Period) UnmarshalCSV(s string) error

UnmarshalCSV reads the Period in CSV form.