archive

type Archive ¶

type Archive struct {
	Meta `bson:",inline"`
	Comp `bson:",inline"`
	Core `bson:",inline"`
}

Archive provides a mechanism to flag documents as archived. This flag enables filtering without preventing access to archived documents. It serves as an alternative to deletion, helping maintain data integrity and supporting queries for deprecated or legacy documents.

func New(m Meta, c Comp, cr Core) *Archive

type Comp ¶

type Comp struct{}

func ApplyComp(c *Comp, modifiers ...CompOption) Comp

type CompOption ¶

type CompOption = contract.CompOption[Comp]

type Core ¶

type Core struct {
	IsArchived *bool `json:"is_archived" validate:"nnpt"`
}

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

func (c *Core) GetIsArchived() bool

func (c *Core) SetIsArchived(x bool)

type CoreOption ¶

type CoreOption = contracti.CoreOption[Core]

func WithIsArchived(x bool) CoreOption

type Meta ¶

type Meta struct{}

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

type MetaOption ¶

type MetaOption = contract.MetaOption[Meta]