Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cache

package

Go to main page

Versions in this module

v0

v0.11.0

Sep 22, 2026

Changes in this version

+ type EntityEventType int

+ const EntityEventCreated

+ const EntityEventRemoved

+ const EntityEventUpdated

+ func (e *EntityEventType) UnmarshalGQL(v interface{}) error

+ func (e EntityEventType) MarshalGQL(w io.Writer)

type MultiRepoCache

+ func (c *MultiRepoCache) AllRepos() []*RepoCache

+ func (c *MultiRepoCache) RegisterObserver(observer Observer, nameFilter string, typename string) error

+ func (c *MultiRepoCache) UnregisterObserver(observer Observer)

+ type Observer interface

+ EntityEvent func(event EntityEventType, repoName string, typename string, id entity.Id)

type RepoCache

+ func (c *RepoCache) BrowseRepo() repository.RepoBrowse

+ func (c *RepoCache) IsDefaultRepo() bool

type SubCache

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) RegisterObserver(repoName string, observer Observer)

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) UnregisterObserver(observer Observer)

v0.10.1

May 19, 2025

v0.10.0

May 18, 2025

v0.9.0

May 12, 2025

v0.8.1

May 5, 2025

Changes in this version

+ var ErrNoMatchingOp = fmt.Errorf("no matching operation found")

+ type Actions struct

+ MergeAll func(repo repository.ClockedRepo, resolvers entity.Resolvers, remote string, ...) <-chan entity.MergeResult

+ ReadAllWithResolver func(repo repository.ClockedRepo, resolvers entity.Resolvers) <-chan entity.StreamedEntity[EntityT]

+ ReadWithResolver func(repo repository.ClockedRepo, resolvers entity.Resolvers, id entity.Id) (EntityT, error)

+ Remove func(repo repository.ClockedRepo, id entity.Id) error

+ RemoveAll func(repo repository.ClockedRepo) error

+ type BugCache struct

+ func NewBugCache(b *bug.Bug, repo repository.ClockedRepo, getUserIdentity getUserIdentityFunc, ...) *BugCache

+ func (c *BugCache) AddComment(message string) (entity.CombinedId, *bug.AddCommentOperation, error)

+ func (c *BugCache) AddCommentRaw(author identity.Interface, unixTime int64, message string, ...) (entity.CombinedId, *bug.AddCommentOperation, error)

+ func (c *BugCache) AddCommentWithFiles(message string, files []repository.Hash) (entity.CombinedId, *bug.AddCommentOperation, error)

+ func (c *BugCache) ChangeLabels(added []string, removed []string) ([]bug.LabelChangeResult, *bug.LabelChangeOperation, error)

+ func (c *BugCache) ChangeLabelsRaw(author identity.Interface, unixTime int64, added []string, removed []string, ...) ([]bug.LabelChangeResult, *bug.LabelChangeOperation, error)

+ func (c *BugCache) Close() (*bug.SetStatusOperation, error)

+ func (c *BugCache) CloseRaw(author identity.Interface, unixTime int64, metadata map[string]string) (*bug.SetStatusOperation, error)

+ func (c *BugCache) EditComment(target entity.CombinedId, message string) (*bug.EditCommentOperation, error)

+ func (c *BugCache) EditCommentRaw(author identity.Interface, unixTime int64, target entity.CombinedId, ...) (*bug.EditCommentOperation, error)

+ func (c *BugCache) EditCreateComment(body string) (entity.CombinedId, *bug.EditCommentOperation, error)

+ func (c *BugCache) EditCreateCommentRaw(author identity.Interface, unixTime int64, body string, ...) (entity.CombinedId, *bug.EditCommentOperation, error)

+ func (c *BugCache) ForceChangeLabels(added []string, removed []string) (*bug.LabelChangeOperation, error)

+ func (c *BugCache) ForceChangeLabelsRaw(author identity.Interface, unixTime int64, added []string, removed []string, ...) (*bug.LabelChangeOperation, error)

+ func (c *BugCache) Open() (*bug.SetStatusOperation, error)

+ func (c *BugCache) OpenRaw(author identity.Interface, unixTime int64, metadata map[string]string) (*bug.SetStatusOperation, error)

+ func (c *BugCache) SetMetadata(target entity.Id, newMetadata map[string]string) (*dag.SetMetadataOperation[*bug.Snapshot], error)

+ func (c *BugCache) SetMetadataRaw(author identity.Interface, unixTime int64, target entity.Id, ...) (*dag.SetMetadataOperation[*bug.Snapshot], error)

+ func (c *BugCache) SetTitle(title string) (*bug.SetTitleOperation, error)

+ func (c *BugCache) SetTitleRaw(author identity.Interface, unixTime int64, title string, ...) (*bug.SetTitleOperation, error)

+ type BugExcerpt struct

+ Actors []entity.Id

+ AuthorId entity.Id

+ CreateLamportTime lamport.Time

+ CreateMetadata map[string]string

+ CreateUnixTime int64

+ EditLamportTime lamport.Time

+ EditUnixTime int64

+ Labels []common.Label

+ LenComments int

+ Participants []entity.Id

+ Status common.Status

+ Title string

+ func NewBugExcerpt(b *BugCache) *BugExcerpt

+ func (b *BugExcerpt) CreateTime() time.Time

+ func (b *BugExcerpt) EditTime() time.Time

+ func (b *BugExcerpt) Id() entity.Id

+ type BugsByCreationTime []*BugExcerpt

+ func (b BugsByCreationTime) Len() int

+ func (b BugsByCreationTime) Less(i, j int) bool

+ func (b BugsByCreationTime) Swap(i, j int)

+ type BugsByEditTime []*BugExcerpt

+ func (b BugsByEditTime) Len() int

+ func (b BugsByEditTime) Less(i, j int) bool

+ func (b BugsByEditTime) Swap(i, j int)

+ type BugsById []*BugExcerpt

+ func (b BugsById) Len() int

+ func (b BugsById) Less(i, j int) bool

+ func (b BugsById) Swap(i, j int)

+ type BuildEvent struct

+ Err error

+ Event BuildEventType

+ Progress int64

+ Total int64

+ Typename string

+ type BuildEventType int

+ const BuildEventCacheIsBuilt

+ const BuildEventFinished

+ const BuildEventProgress

+ const BuildEventRemoveLock

+ const BuildEventStarted

+ type CacheEntity interface

+ Id func() entity.Id

+ Lock func()

+ NeedCommit func() bool

+ type CachedEntityBase struct

+ func (e *CachedEntityBase[SnapT, OpT]) Commit() error

+ func (e *CachedEntityBase[SnapT, OpT]) CommitAsNeeded() error

+ func (e *CachedEntityBase[SnapT, OpT]) CreateLamportTime() lamport.Time

+ func (e *CachedEntityBase[SnapT, OpT]) EditLamportTime() lamport.Time

+ func (e *CachedEntityBase[SnapT, OpT]) FirstOp() OpT

+ func (e *CachedEntityBase[SnapT, OpT]) Id() entity.Id

+ func (e *CachedEntityBase[SnapT, OpT]) Lock()

+ func (e *CachedEntityBase[SnapT, OpT]) NeedCommit() bool

+ func (e *CachedEntityBase[SnapT, OpT]) ResolveOperationWithMetadata(key string, value string) (entity.Id, error)

+ func (e *CachedEntityBase[SnapT, OpT]) Snapshot() SnapT

+ func (e *CachedEntityBase[SnapT, OpT]) Validate() error

+ type Excerpt interface

+ Id func() entity.Id

+ type Filter func(excerpt *BugExcerpt, resolvers entity.Resolvers) bool

+ func ActorFilter(query string) Filter

+ func AuthorFilter(query string) Filter

+ func LabelFilter(label string) Filter

+ func MetadataFilter(pair query.StringPair) Filter

+ func NoLabelFilter() Filter

+ func ParticipantFilter(query string) Filter

+ func StatusFilter(status common.Status) Filter

+ func TitleFilter(query string) Filter

+ type IdentityById []*IdentityExcerpt

+ func (b IdentityById) Len() int

+ func (b IdentityById) Less(i, j int) bool

+ func (b IdentityById) Swap(i, j int)

+ type IdentityCache struct

+ func NewIdentityCache(i *identity.Identity, repo repository.ClockedRepo, ...) *IdentityCache

+ func (i *IdentityCache) Commit() error

+ func (i *IdentityCache) CommitAsNeeded() error

+ func (i *IdentityCache) Lock()

+ func (i *IdentityCache) Mutate(repo repository.RepoClock, f func(*identity.Mutator)) error

+ type IdentityExcerpt struct

+ ImmutableMetadata map[string]string

+ Login string

+ Name string

+ func NewIdentityExcerpt(i *IdentityCache) *IdentityExcerpt

+ func (i *IdentityExcerpt) DisplayName() string

+ func (i *IdentityExcerpt) Id() entity.Id

+ func (i *IdentityExcerpt) Match(query string) bool

+ type Matcher struct

+ Actor []Filter

+ Author []Filter

+ Label []Filter

+ Metadata []Filter

+ NoFilters []Filter

+ Participant []Filter

+ Status []Filter

+ Title []Filter

+ func (f *Matcher) Match(excerpt *BugExcerpt, resolvers entity.Resolvers) bool

+ type MultiRepoCache struct

+ func NewMultiRepoCache() *MultiRepoCache

+ func (c *MultiRepoCache) Close() error

+ func (c *MultiRepoCache) DefaultRepo() (*RepoCache, error)

+ func (c *MultiRepoCache) RegisterDefaultRepository(repo repository.ClockedRepo) (*RepoCache, chan BuildEvent)

+ func (c *MultiRepoCache) RegisterRepository(repo repository.ClockedRepo, name string) (*RepoCache, chan BuildEvent)

+ func (c *MultiRepoCache) ResolveRepo(name string) (*RepoCache, error)

+ type RepoCache struct

+ func NewNamedRepoCache(r repository.ClockedRepo, name string) (*RepoCache, chan BuildEvent)

+ func NewRepoCache(r repository.ClockedRepo) (*RepoCache, chan BuildEvent)

+ func NewRepoCacheNoEvents(r repository.ClockedRepo) (*RepoCache, error)

+ func (c *RepoCache) AnyConfig() repository.ConfigRead

+ func (c *RepoCache) Bugs() *RepoCacheBug

+ func (c *RepoCache) ClearUserIdentity() error

+ func (c *RepoCache) Close() error

+ func (c *RepoCache) Fetch(remote string) (string, error)

+ func (c *RepoCache) GetCoreEditor() (string, error)

+ func (c *RepoCache) GetRemotes() (map[string]string, error)

+ func (c *RepoCache) GetUserEmail() (string, error)

+ func (c *RepoCache) GetUserIdentity() (*IdentityCache, error)

+ func (c *RepoCache) GetUserIdentityExcerpt() (*IdentityExcerpt, error)

+ func (c *RepoCache) GetUserName() (string, error)

+ func (c *RepoCache) GlobalConfig() repository.Config

+ func (c *RepoCache) Identities() *RepoCacheIdentity

+ func (c *RepoCache) IsUserIdentitySet() (bool, error)

+ func (c *RepoCache) Keyring() repository.Keyring

+ func (c *RepoCache) LocalConfig() repository.Config

+ func (c *RepoCache) LocalStorage() repository.LocalStorage

+ func (c *RepoCache) MergeAll(remote string) <-chan entity.MergeResult

+ func (c *RepoCache) Name() string

+ func (c *RepoCache) Pull(remote string) error

+ func (c *RepoCache) Push(remote string) (string, error)

+ func (c *RepoCache) ReadData(hash repository.Hash) ([]byte, error)

+ func (c *RepoCache) RemoveAll() error

+ func (c *RepoCache) SetUserIdentity(i *IdentityCache) error

+ func (c *RepoCache) StoreData(data []byte) (repository.Hash, error)

+ type RepoCacheBug struct

+ func NewRepoCacheBug(repo repository.ClockedRepo, resolvers func() entity.Resolvers, ...) *RepoCacheBug

+ func (c *RepoCacheBug) New(title string, message string) (*BugCache, *bug.CreateOperation, error)

+ func (c *RepoCacheBug) NewRaw(author identity.Interface, unixTime int64, title string, message string, ...) (*BugCache, *bug.CreateOperation, error)

+ func (c *RepoCacheBug) NewWithFiles(title string, message string, files []repository.Hash) (*BugCache, *bug.CreateOperation, error)

+ func (c *RepoCacheBug) Query(q *query.Query) ([]entity.Id, error)

+ func (c *RepoCacheBug) ResolveBugCreateMetadata(key string, value string) (*BugCache, error)

+ func (c *RepoCacheBug) ResolveComment(prefix string) (*BugCache, entity.CombinedId, error)

+ func (c *RepoCacheBug) ValidLabels() []common.Label

+ type RepoCacheIdentity struct

+ func NewRepoCacheIdentity(repo repository.ClockedRepo, resolvers func() entity.Resolvers, ...) *RepoCacheIdentity

+ func (c *RepoCacheIdentity) New(name string, email string) (*IdentityCache, error)

+ func (c *RepoCacheIdentity) NewFromGitUser() (*IdentityCache, error)

+ func (c *RepoCacheIdentity) NewFromGitUserRaw(metadata map[string]string) (*IdentityCache, error)

+ func (c *RepoCacheIdentity) NewFull(name string, email string, login string, avatarUrl string, ...) (*IdentityCache, error)

+ func (c *RepoCacheIdentity) NewRaw(name string, email string, login string, avatarUrl string, ...) (*IdentityCache, error)

+ func (c *RepoCacheIdentity) ResolveIdentityImmutableMetadata(key string, value string) (*IdentityCache, error)

+ type SubCache struct

+ func NewSubCache[EntityT entity.Interface, ExcerptT Excerpt, CacheT CacheEntity](repo repository.ClockedRepo, resolvers func() entity.Resolvers, ...) *SubCache[EntityT, ExcerptT, CacheT]

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) AllIds() []entity.Id

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) Build() <-chan BuildEvent

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) Close() error

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) GetNamespace() string

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) Load() error

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) MergeAll(remote string) <-chan entity.MergeResult

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) Remove(prefix string) error

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) RemoveAll() error

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) Resolve(id entity.Id) (CacheT, error)

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) ResolveExcerpt(id entity.Id) (ExcerptT, error)

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) ResolveExcerptMatcher(f func(ExcerptT) bool) (ExcerptT, error)

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) ResolveExcerptPrefix(prefix string) (ExcerptT, error)

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) ResolveMatcher(f func(ExcerptT) bool) (CacheT, error)

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) ResolvePrefix(prefix string) (CacheT, error)

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) SetCacheSize(size int)

+ func (sc *SubCache[EntityT, ExcerptT, CacheT]) Typename() string