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.5.0

Jul 27, 2026

v0.4.0

Jul 21, 2026

Changes in this version

+ func StatAuthoritative(ctx context.Context, c Cache, key Key, opts ...Option) (http.Header, error)

+ type AuthoritativeStater interface

+ AuthoritativeStat func(ctx context.Context, key Key, opts ...Option) (http.Header, error)

type Tiered

+ func (t Tiered) AuthoritativeStat(ctx context.Context, key Key, opts ...Option) (http.Header, error)

v0.3.1

Jul 20, 2026

v0.3.0

Jul 13, 2026

Changes in this version

+ func FormatETag(etag string) (string, error)

+ func RawETagFromHeader(etag string) (string, error)

+ func ValidateRawETag(etag string) error

type Cache

+ Invalidate func(ctx context.Context, key Key) error

type Disk

+ func (d *Disk) Invalidate(ctx context.Context, key Key) error

type Memory

+ func (m *Memory) Invalidate(ctx context.Context, key Key) error

type Option

+ func WithETag(etag string) Option

type Remote

+ func (r *Remote) Invalidate(ctx context.Context, key Key) error

type S3

+ func (s *S3) Invalidate(ctx context.Context, key Key) error

type Tiered

+ func (t Tiered) Invalidate(ctx context.Context, key Key) error

v0.2.1

Jun 25, 2026

v0.2.0

Jun 25, 2026

v0.1.1

Jun 24, 2026

v0.1.0

Jun 24, 2026

Changes in this version

+ const ETagKey

+ const RangeFull

+ const RangeNotSatisfiable

+ const RangePartial

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

+ var ErrNotModified = client.ErrNotModified

+ var ErrPreconditionFailed = client.ErrPreconditionFailed

+ var ErrRangeNotSatisfiable = client.ErrRangeNotSatisfiable

+ var ErrStatsUnavailable = client.ErrStatsUnavailable

+ func Fetch(client *http.Client, r *http.Request, c Cache) (*http.Response, error)

+ func FetchDirect(client *http.Client, r *http.Request, c Cache, key Key) (*http.Response, error)

+ func NewHTTPClient(headerFunc HeaderFunc) *http.Client

+ func ParallelGet(ctx context.Context, c Cache, key Key, dst io.WriterAt, chunkSize int64, ...) error

+ func RegisterDisk(r *Registry)

+ func RegisterMemory(r *Registry)

+ func RegisterS3(r *Registry, clientProvider s3client.ClientProvider)

+ func Register[Config any, C Cache](r *Registry, id, description string, factory Factory[Config, C])

+ func ValidateNamespace(name string) error

+ func WriteFunc(ctx context.Context, c Cache, key Key, headers http.Header, ttl time.Duration, ...) error

+ type Cache interface

+ Close func() error

+ Create func(ctx context.Context, key Key, headers http.Header, ttl time.Duration) (Writer, error)

+ Delete func(ctx context.Context, key Key) error

+ ListNamespaces func(ctx context.Context) ([]string, error)

+ Namespace func(namespace Namespace) Cache

+ Open func(ctx context.Context, key Key, opts ...Option) (io.ReadCloser, http.Header, error)

+ Stat func(ctx context.Context, key Key, opts ...Option) (http.Header, error)

+ Stats func(ctx context.Context) (Stats, error)

+ String func() string

+ func MaybeNewTiered(ctx context.Context, caches []Cache) Cache

+ func NoOpCache() Cache

+ type Disk struct

+ func NewDisk(ctx context.Context, config DiskConfig) (*Disk, error)

+ func (d *Disk) Close() error

+ func (d *Disk) Create(ctx context.Context, key Key, headers http.Header, ttl time.Duration) (Writer, error)

+ func (d *Disk) Delete(_ context.Context, key Key) error

+ func (d *Disk) ListNamespaces(_ context.Context) ([]string, error)

+ func (d *Disk) Namespace(namespace Namespace) Cache

+ func (d *Disk) Open(ctx context.Context, key Key, opts ...Option) (io.ReadCloser, http.Header, error)

+ func (d *Disk) Size() int64

+ func (d *Disk) Stat(ctx context.Context, key Key, opts ...Option) (http.Header, error)

+ func (d *Disk) Stats(_ context.Context) (Stats, error)

+ func (d *Disk) String() string

+ type DiskConfig struct

+ EvictInterval time.Duration

+ LimitMB int

+ MaxTTL time.Duration

+ Root string

+ type Factory func(ctx context.Context, config Config) (C, error)

+ type HeaderFunc = client.HeaderFunc

+ type Key = client.Key

+ func NewKey(s string) Key

+ func ParseKey(key string) (Key, error)

+ type Memory struct

+ func NewMemory(ctx context.Context, config MemoryConfig) (*Memory, error)

+ func (m *Memory) Close() error

+ func (m *Memory) Create(ctx context.Context, key Key, headers http.Header, ttl time.Duration) (Writer, error)

+ func (m *Memory) Delete(_ context.Context, key Key) error

+ func (m *Memory) ListNamespaces(_ context.Context) ([]string, error)

+ func (m *Memory) Namespace(namespace Namespace) Cache

+ func (m *Memory) Open(_ context.Context, key Key, opts ...Option) (io.ReadCloser, http.Header, error)

+ func (m *Memory) Stat(_ context.Context, key Key, opts ...Option) (http.Header, error)

+ func (m *Memory) Stats(_ context.Context) (Stats, error)

+ func (m *Memory) String() string

+ type MemoryConfig struct

+ LimitMB int

+ MaxTTL time.Duration

+ type Namespace = client.Namespace

+ func ParseNamespace(name string) (Namespace, error)

+ type Option = client.RequestOption

+ func IfMatch(etag string) Option

+ func IfNoneMatch(etag string) Option

+ func IfRange(etag string) Option

+ func Range(start, end int64) Option

+ type RangeOutcome = client.RangeOutcome

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) Create(ctx context.Context, name string, config *hcl.Block, vars map[string]string) (Cache, error)

+ func (r *Registry) Exists(name string) bool

+ func (r *Registry) Schema() *hcl.AST

+ type Remote struct

+ func NewRemote(baseURL string, headerFunc HeaderFunc) *Remote

+ func (r *Remote) Close() error

+ func (r *Remote) Create(ctx context.Context, key Key, headers http.Header, ttl time.Duration) (Writer, error)

+ func (r *Remote) Delete(ctx context.Context, key Key) error

+ func (r *Remote) ListNamespaces(ctx context.Context) ([]string, error)

+ func (r *Remote) Namespace(namespace Namespace) Cache

+ func (r *Remote) Open(ctx context.Context, key Key, opts ...Option) (io.ReadCloser, http.Header, error)

+ func (r *Remote) Stat(ctx context.Context, key Key, opts ...Option) (http.Header, error)

+ func (r *Remote) Stats(ctx context.Context) (Stats, error)

+ func (r *Remote) String() string

+ type RequestOptions = client.RequestOptions

+ func NewRequestOptions(opts ...Option) RequestOptions

+ type S3 struct

+ func NewS3(ctx context.Context, config S3Config, clientProvider s3client.ClientProvider) (*S3, error)

+ func (s *S3) Close() error

+ func (s *S3) Create(ctx context.Context, key Key, headers http.Header, ttl time.Duration) (Writer, error)

+ func (s *S3) Delete(ctx context.Context, key Key) error

+ func (s *S3) ListNamespaces(_ context.Context) ([]string, error)

+ func (s *S3) Namespace(namespace Namespace) Cache

+ func (s *S3) Open(ctx context.Context, key Key, opts ...Option) (io.ReadCloser, http.Header, error)

+ func (s *S3) Stat(ctx context.Context, key Key, opts ...Option) (http.Header, error)

+ func (s *S3) Stats(_ context.Context) (Stats, error)

+ func (s *S3) String() string

+ type S3Config struct

+ Bucket string

+ DownloadConcurrency uint

+ DownloadPartSizeMB uint

+ MaxTTL time.Duration

+ UploadConcurrency uint

+ UploadPartSizeMB uint

+ type Stats = client.Stats

+ type Tiered struct

+ func (t Tiered) Close() error

+ func (t Tiered) Create(ctx context.Context, key Key, headers http.Header, ttl time.Duration) (Writer, error)

+ func (t Tiered) Delete(ctx context.Context, key Key) error

+ func (t Tiered) ListNamespaces(ctx context.Context) ([]string, error)

+ func (t Tiered) Namespace(namespace Namespace) Cache

+ func (t Tiered) Open(ctx context.Context, key Key, opts ...Option) (io.ReadCloser, http.Header, error)

+ func (t Tiered) Stat(ctx context.Context, key Key, opts ...Option) (http.Header, error)

+ func (t Tiered) Stats(ctx context.Context) (Stats, error)

+ func (t Tiered) String() string

+ type Writer = client.CacheWriter