cache

package

v0.0.1 Latest Latest Go to latest Published: May 23, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jetstack/tally

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func NewScorecardClient(ca Cache, client scorecard.Client) scorecard.Client
type Cache
- func NewSqliteCache(dbDir string, opts ...Option) (Cache, error)
type Option
- func WithDuration(d time.Duration) Option
type ScorecardClient
- func (c *ScorecardClient) GetResult(ctx context.Context, repository string) (*models.ScorecardResult, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNotFound = errors.New("not found in cache")

ErrNotFound is returned when a result isn't found in the cache

Functions ¶

func NewScorecardClient ¶

func NewScorecardClient(ca Cache, client scorecard.Client) scorecard.Client

NewScorecardClient returns a scorecard client that caches scores from another client

Types ¶

type Cache ¶

type Cache interface {
	// GetResult retrieves a scorecard result from the cache
	GetResult(ctx context.Context, repository string) (*models.ScorecardResult, error)

	// PutResult inserts a score into the cache
	PutResult(ctx context.Context, repository string, result *models.ScorecardResult) error
}

Cache caches results

func NewSqliteCache ¶

func NewSqliteCache(dbDir string, opts ...Option) (Cache, error)

NewSqliteCache returns a cache implementation that stores scorecard scores in a local sqlite database

type Option ¶

type Option func(o *options)

Option is a functional option that configures a cache

func WithDuration ¶

func WithDuration(d time.Duration) Option

WithDuration is a functional option that configures the amount of time until an item in the cache is invalidated

type ScorecardClient ¶

type ScorecardClient struct {
	scorecard.Client
	// contains filtered or unexported fields
}

ScorecardClient wraps another scorecard client, caching the scores it retrieves

func (*ScorecardClient) GetResult ¶

func (c *ScorecardClient) GetResult(ctx context.Context, repository string) (*models.ScorecardResult, error)

GetResult attempts to get the scorecard result from the cache. Failing that it will get the scorecard result from the wrapped client and cache it for next time.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL