window

Documentation

Index

• Variables
• type Window
  • func Generate(rand *rand.Rand) Window
  • func New(lo, hi time.Time) (Window, validation.ErrorGroup)
  • func (w Window) Check() validation.ErrorGroup
  • func (w Window) Duration() time.Duration
  • func (w Window) Equals(v any) bool
  • func (Window) Generate(rand *rand.Rand, size int) reflect.Value
  • func (w Window) Overlaps(w2 Window) bool
  • func (w Window) String() string

Variables

var ErrHiGreaterThanLo = validation.NewError(
	"window_hi_must_be_greater_than_lo",
	"the window hi value must be greater than the lo value",
)

ErrHiGreaterThanLo is the validation check error returned when the window hi is before the lo.

var ErrLoMustBeNewerThanUnixEpoch = validation.NewError(
	"window_lo_must_be_newer_than_unix_epoch",
	fmt.Sprintf("the window lo value must be newer than %s", unixEpoch),
)

ErrLoMustBeNewerThanUnixEpoch is the validation check error returned when the window is before the unix epoch (Jan 1st, 1970).

Types

type Window

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

func Generate

func Generate(rand *rand.Rand) Window

Generate a random Window value.

func New

func New(lo, hi time.Time) (Window, validation.ErrorGroup)

New creates and validates a new Window from the given values.

func (Window) Check

func (w Window) Check() validation.ErrorGroup

Check runs default validation checks for the Window.

func (Window) Duration

func (w Window) Duration() time.Duration

Duration returns the time duration of the window.

func (Window) Equals

func (w Window) Equals(v any) bool

Equals compares two Window instances for equality.

Interface: comparison.Equaler

func (Window) Generate

func (Window) Generate(rand *rand.Rand, size int) reflect.Value

Generate random Window values.

Interface: quick.Generator

func (Window) Overlaps

func (w Window) Overlaps(w2 Window) bool

Overlaps returns true when the two time windows overlap.

func (Window) String

func (w Window) String() string

String value of the Window.

Interface: fmt.Stringer.