identity

Documentation

Index

• Constants
• type IdentityResolver
  • func NewResolver(required LifecycleIdentity) *IdentityResolver
  • func (ir *IdentityResolver) CacheID() string
  • func (ir *IdentityResolver) CellEnabled() bool
  • func (ir *IdentityResolver) DocumentEnabled() bool
  • func (ir *IdentityResolver) GetCellID(obj any, attributes map[string]string) (string, bool)
• type LifecycleIdentities
  • func (ids LifecycleIdentities) Contains(id LifecycleIdentity) bool
• type LifecycleIdentity

Constants

const DefaultLifecycleIdentity = UnspecifiedLifecycleIdentity

Types

type IdentityResolver

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

func NewResolver

func NewResolver(required LifecycleIdentity) *IdentityResolver

func (*IdentityResolver) CacheID

func (ir *IdentityResolver) CacheID() string

CacheID returns a new document ID which is not persisted.

func (*IdentityResolver) CellEnabled

func (ir *IdentityResolver) CellEnabled() bool

CellEnabled returns true if the resolver is configured to generate cell identities.

func (*IdentityResolver) DocumentEnabled

func (ir *IdentityResolver) DocumentEnabled() bool

DocumentEnabled returns true if the resolver is configured to generate document identities.

func (*IdentityResolver) GetCellID

func (ir *IdentityResolver) GetCellID(obj any, attributes map[string]string) (string, bool)

GetCellID returns a cell ID and a boolean indicating if it's new or from attributes.

type LifecycleIdentities

type LifecycleIdentities []LifecycleIdentity

func (LifecycleIdentities) Contains

func (ids LifecycleIdentities) Contains(id LifecycleIdentity) bool

Contains returns true if the required identity is contained in the provided identities.

type LifecycleIdentity

type LifecycleIdentity int

const (
	UnspecifiedLifecycleIdentity LifecycleIdentity = iota
	AllLifecycleIdentity
	DocumentLifecycleIdentity
	CellLifecycleIdentity
)

LifecycleIdentities are used to determine which object identities should be generated. The default is to generate all identities.

The following identities are supported: - UnspecifiedLifecycleIdentity: No identity is generated. - AllLifecycleIdentity: All identities are generated. - DocumentLifecycleIdentity: Document identities are generated. - CellLifecycleIdentity: Cell identities are generated.