periods

package

v0.0.310 Latest Latest Go to latest Published: Mar 27, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Details

View Source

const (
	PeriodIndexesKey = "period_indexes"
)

View Source

const (
	PeriodsKey = "periods"
)

View Source

var PeriodIndexesKeyFn = contract.PathKeyFn(PeriodIndexesKey)

View Source

var PeriodsKeyFn = contract.PathKeyFn(PeriodsKey)

func Idx(p ...string) []contract.IndexEntry

func IdxSrch(p ...string) []contract.SearchIndexEntry

func Rules(p ...string) contractpkg.QueryParamRules

type Comp struct {
	PeriodIndexes *[]int64 `json:"period_indexes" validate:"nnpt,nz"`
}

func (c *Comp) GetPeriodIndexes() []int64

func (c *Comp) SetPeriodIndexes(x []int64)

type Core struct {
	Periods *[]period.Period `json:"periods" validate:"nnpt,nz"`
}

func ApplyCore(c *Core, modifiers ...CoreOption) Core

func (c *Core) GetPeriods() []period.Period

func (c *Core) SetPeriods(x []period.Period)

type CoreOption = contracti.CoreOption[Core]

func WithPeriods(x []period.Period) CoreOption

type Meta struct{}

func ApplyMeta(m *Meta, modifiers ...MetaOption) Meta

type MetaOption = contract.MetaOption[Meta]

type Periods struct {
	Meta `bson:",inline" validate:"recurse"`
	Comp `bson:",inline" validate:"recurse"`
	Core `bson:",inline" validate:"recurse"`
}

Periods represents a set of periods.

func Mock() *Periods

func MockWithComp() *Periods

func New(m Meta, cr Core) *Periods

func (r *Periods) Compute(ctx context.Context) error

func (r *Periods) Normalize()

Normalize deduplicates and sorts the stored periods by year and period.

func (r *Periods) PeriodIndexStrings() []string

PeriodIndexStrings returns indexes as a slice of strings.