trufflehog/pkg/cache/cache.go
2024-06-06 13:08:00 -04:00

24 lines
811 B
Go

// Package cache provides an interface which can be implemented by different cache types.
package cache
// Cache is used to store key/value pairs.
type Cache[T any] interface {
// Set stores the given key/value pair.
Set(string, T)
// Get returns the value for the given key and a boolean indicating if the key was found.
Get(string) (T, bool)
// Exists returns true if the given key exists in the cache.
Exists(string) bool
// Delete the given key from the cache.
Delete(string)
// Clear all key/value pairs from the cache.
Clear()
// Count the number of key/value pairs in the cache.
Count() int
// Keys returns all keys in the cache.
Keys() []string
// Values returns all values in the cache.
Values() []T
// Contents returns all keys in the cache encoded as a string.
Contents() string
}