util

Documentation

Index

• Constants
• func NewPod(namespace, name string) v1.Pod
• func ParseDays(days string) ([]time.Time, error)
• func ParseWeekdays(weekdays string) []time.Weekday
• func TimeOfDay(pointInTime time.Time) time.Time
• type TimePeriod
  • func NewTimePeriod(from, to time.Time) TimePeriod
  • func ParseTimePeriods(timePeriods string) ([]TimePeriod, error)
  • func (tp TimePeriod) Includes(pointInTime time.Time) bool
  • func (tp TimePeriod) String() string

Constants

const (
	// a short time format; like time.Kitchen but with 24-hour notation.
	Kitchen24 = "15:04"
	// a time format that just cares about the day and month.
	YearDay = "Jan_2"
)

Functions

func NewPod

func NewPod(namespace, name string) v1.Pod

NewPod returns a new pod instance for testing purposes.

func ParseDays

func ParseDays(days string) ([]time.Time, error)

func ParseWeekdays

func ParseWeekdays(weekdays string) []time.Weekday

ParseWeekdays takes a comma-separated list of abbreviated weekdays (e.g. sat,sun) and turns them into a slice of time.Weekday. It ignores any whitespace and any invalid weekdays.

func TimeOfDay

func TimeOfDay(pointInTime time.Time) time.Time

TimeOfDay normalizes the given point in time by returning a time object that represents the same time of day of the given time but on the very first day (day 0).

Types

type TimePeriod

type TimePeriod struct {
	From time.Time
	To   time.Time
}

TimePeriod represents a time period with a single beginning and end.

func NewTimePeriod

func NewTimePeriod(from, to time.Time) TimePeriod

NewTimePeriod returns a normalized TimePeriod given a start and end time.

func ParseTimePeriods

func ParseTimePeriods(timePeriods string) ([]TimePeriod, error)

ParseTimePeriods takes a comma-separated list of time periods in Kitchen24 format and turns them into a slice of TimePeriods. It ignores any whitespace.

func (TimePeriod) Includes

func (tp TimePeriod) Includes(pointInTime time.Time) bool

Includes returns true iff the given pointInTime's time of day is included in time period tp.

func (TimePeriod) String

func (tp TimePeriod) String() string

String returns tp as a pretty string.