schedule

Documentation

Overview

Package schedule provides types for scheduling.

Index

• type Weekly
  • func EmptyWeekly() (w *Weekly)
  • func FullWeekly() (w *Weekly)
  • func (w *Weekly) Clone() (c *Weekly)
  • func (w *Weekly) Contains(t time.Time) (ok bool)
  • func (w *Weekly) MarshalYAML() (v any, err error)
  • func (w *Weekly) UnmarshalYAML(value *yaml.Node) (err error)

Types

type Weekly

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

Weekly is a schedule for one week. Each day of the week has one range with a beginning and an end.

func EmptyWeekly

func EmptyWeekly() (w *Weekly)

EmptyWeekly creates empty weekly schedule with local time zone.

func FullWeekly

func FullWeekly() (w *Weekly)

FullWeekly creates full weekly schedule with local time zone.

TODO(s.chzhen): Consider moving into tests.

func (*Weekly) Clone

func (w *Weekly) Clone() (c *Weekly)

Clone returns a deep copy of a weekly.

func (*Weekly) Contains

func (w *Weekly) Contains(t time.Time) (ok bool)

Contains returns true if t is within the corresponding day range of the schedule in the schedule's time zone.

func (*Weekly) MarshalYAML

func (w *Weekly) MarshalYAML() (v any, err error)

MarshalYAML implements the yaml.Marshaler interface for *Weekly.

func (*Weekly) UnmarshalYAML

func (w *Weekly) UnmarshalYAML(value *yaml.Node) (err error)

UnmarshalYAML implements the yaml.Unmarshaler interface for *Weekly.