utils

Documentation

Index

• func DateFromISOWeek(isoYear int, isoWeek int) (date time.Time)
• func ExtractGzip(file, destDir string, skipHidden bool) (root string, err error)
• func Latest(a, b string) string
• func ValidateCommonName(name string) (err error)
• func WithDeadline(ctx context.Context) (context.Context, context.CancelFunc)
• func WriteGzip(dir, file string) (err error)
• type Week
  • func NewWeek(date time.Time) (week *Week)
  • func (w *Week) Sub(u *Week) int
• type WeekIterator
  • func GetWeekIterator(start time.Time, end time.Time) (iter *WeekIterator, err error)
  • func (i *WeekIterator) Next() (week *Week, ok bool)

Functions

func DateFromISOWeek

func DateFromISOWeek(isoYear int, isoWeek int) (date time.Time)

Calculate the actual date which represents the start of the given ISOWeek

func ExtractGzip

func ExtractGzip(file, destDir string, skipHidden bool) (root string, err error)

ExtractGzip extracts a gzipped archive to the specified directory and returns the path to the root level of the extracted archive. Caller must ensure that the destination directory exists.

func Latest

func Latest(a, b string) string

Helper method to return the latest string timestamp from the two RFC3339 timestamps

func ValidateCommonName

func ValidateCommonName(name string) (err error)

Validate a common name. The common name should not be empty, nor start with an "*" (e.g. a DNS wildcard). It should not start with a - and each label should be no more than 63 octets long. The common name should not have a scheme e.g. https:// prefix and it shouldn't have a port, e.g. example.com:443. Parsing is primarily based on a regular expression match from the cnre pattern.

func WithDeadline

func WithDeadline(ctx context.Context) (context.Context, context.CancelFunc)

func WriteGzip

func WriteGzip(dir, file string) (err error)

WriteGzip compresses a directory to a gzipped archive.

Types

type Week

type Week struct {
	Date    time.Time
	Year    int
	WeekNum int
}

func NewWeek

func NewWeek(date time.Time) (week *Week)

Returns a new Week object given a time.Time

func (*Week) Sub

func (w *Week) Sub(u *Week) int

Returns the difference w-u between two Weeks, in terms of number of weeks

type WeekIterator

type WeekIterator struct {
	Start   *Week
	Current *Week
	End     *Week
}

func GetWeekIterator

func GetWeekIterator(start time.Time, end time.Time) (iter *WeekIterator, err error)

Takes in a time range and returns a WeekIterator

func (*WeekIterator) Next

func (i *WeekIterator) Next() (week *Week, ok bool)

Returns the next Week from the WeekIterator