ingestcache

Documentation

Overview

Package ingestcache a cache that is used to cache the results of ingesting data. The intent is to reduce the number of calls to external services.

Index

• Variables
• type Cache
  • func NewCache() Cache
  • func NewNoopCache() Cache
• type NoopCache
  • func (*NoopCache) Get(_ interfaces.Ingester, _ protoreflect.ProtoMessage, _ map[string]any) (*interfaces.Result, bool)
  • func (*NoopCache) Set(_ interfaces.Ingester, _ protoreflect.ProtoMessage, _ map[string]any, ...)

Variables

var ErrBuildingCacheKey = errors.New("error building cache key")

ErrBuildingCacheKey is the error returned when building a cache key fails

Types

type Cache

type Cache interface {
	Get(ingester interfaces.Ingester, entity protoreflect.ProtoMessage, params map[string]any) (*interfaces.Result, bool)
	Set(ingester interfaces.Ingester, entity protoreflect.ProtoMessage, params map[string]any, result *interfaces.Result)
}

Cache is the interface for the ingest cache.

func NewCache

func NewCache() Cache

NewCache returns a new cache

func NewNoopCache

func NewNoopCache() Cache

NewNoopCache returns a new NoopCache

type NoopCache

type NoopCache struct {
}

NoopCache is the interface for the ingest cache.

func (*NoopCache) Get

func (*NoopCache) Get(
	_ interfaces.Ingester,
	_ protoreflect.ProtoMessage,
	_ map[string]any,
) (*interfaces.Result, bool)

Get implements the Cache interface but does nothing

func (*NoopCache) Set

func (*NoopCache) Set(
	_ interfaces.Ingester,
	_ protoreflect.ProtoMessage,
	_ map[string]any,
	_ *interfaces.Result,
)

Set implements the Cache interface but does nothing