archive

type Archive ¶

type Archive struct {
	Meta `bson:",inline"`
	Comp `bson:",inline"`
	// IsArchived indicates whether the document is archived.
	// example:false
	// required:false
	IsArchived *bool `bson:"is_archived" json:"is_archived" validate:"nonnilpointer"`
}

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. swagger:model

func NewArchive(m Meta, c Comp, isArchived bool) (*Archive, error)

func (a *Archive) GetIsArchived() bool

func (a *Archive) SetIsArchived(x bool)

type Comp ¶

type Comp struct{}

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

type CompOption ¶

type CompOption = contract.CompOption[Comp]

type Meta ¶

type Meta struct{}

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

type MetaOption ¶

type MetaOption = contract.MetaOption[Meta]