Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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
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

filecache

package module

Go to main page

Versions in this module

v2

v2.1.2

Mar 4, 2024

Changes in this version

type FileCache

+ func NewInTemp(options ...InstanceOptions) (FileCache, error)

v2.1.1

Jan 22, 2024

v2.1.0

Jan 22, 2024

Changes in this version

type FileCache

+ Close func() error

+ type GarbageCollector interface

+ Close func() error

+ OnInstanceInit func()

+ OnOperation func()

+ func NewIntervalGarbageCollector(dir string, interval time.Duration) GarbageCollector

+ func NewNopGarbageCollector() GarbageCollector

+ func NewProbabilityGarbageCollector(dir string, onInitDivisor uint, onOpDivisor uint) GarbageCollector

type InstanceOptions

+ GC GarbageCollector

v2.0.2

Oct 31, 2023

Changes in this version

+ const TTLEternal

+ var ErrDirNotExists = errors.New("directory does not exist")

+ var ErrNotADir = errors.New("not a directory")

+ func FilteredKeyPath(key string) string

+ func HashedKeyPath(key string) string

+ func HashedKeySplitPath(key string) string

+ type FileCache interface

+ GetPath func() string

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

+ Open func(ctx context.Context, key string) (result *OpenResult, err error)

+ Read func(ctx context.Context, key string) (result *ReadResult, err error)

+ Write func(ctx context.Context, key string, reader io.Reader, options ...ItemOptions) (written int64, err error)

+ WriteData func(ctx context.Context, key string, data []byte, options ...ItemOptions) (written int64, err error)

+ func New(targetDir string, options ...InstanceOptions) (FileCache, error)

+ func NewNop() FileCache

+ type InstanceOptions struct

+ DefaultTTL time.Duration

+ GCDivisor uint

+ PathGenerator PathGeneratorFn

+ type ItemOptions struct

+ Fields Values

+ Name string

+ TTL time.Duration

+ type OpenResult struct

+ func (r *OpenResult) Hit() bool

+ func (r *OpenResult) Options() *ItemOptions

+ func (r *OpenResult) Reader() io.ReadCloser

+ type PathGeneratorFn func(key string) string

+ func WithExt(fn PathGeneratorFn, ext string) PathGeneratorFn

+ type ReadResult struct

+ func (r *ReadResult) Data() []byte

+ func (r *ReadResult) Hit() bool

+ func (r *ReadResult) Options() *ItemOptions

+ type ScanEntry struct

+ CreatedAt time.Time

+ Key string

+ Options *ItemOptions

+ type Scanner interface

+ Scan func(onHit ScannerHitFn) error

+ func NewScanner(dir string) Scanner

+ type ScannerHitFn func(entry ScanEntry) error

+ type Values map[string]any

+ func NewValues(keysAndValues ...any) Values

Other modules containing this package

github.com/kukymbr/filecache