retentiongrid

Documentation

Index

• Constants
• type Entry
• type Grid
  • func NewGrid(l []Interval) *Grid
  • func (g Grid) FitEntries(now time.Time, entries []Entry) (keep, remove []Entry)
• type Interval

Constants

const RetentionGridKeepCountAll int = -1

Types

type Entry

type Entry interface {
	Date() time.Time
	LessThan(b Entry) bool
}

A point inside the grid, i.e. a thing the grid can decide to remove

type Grid

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

func NewGrid

func NewGrid(l []Interval) *Grid

func (Grid) FitEntries

func (g Grid) FitEntries(now time.Time, entries []Entry) (keep, remove []Entry)

Partition a list of RetentionGridEntries into the Grid, relative to a given start date `now`.

The `keepCount` oldest entries per `retentiongrid.Interval` are kept (`keep`), the others are removed (`remove`).

Entries that are younger than `now` are always kept. Those that are older than the earliest beginning of an interval are removed.

type Interval

type Interval interface {
	Length() time.Duration
	KeepCount() int
}