cache

Documentation

Overview

Package cache contains a read-only cache file system.

Index

• type ReadOnlyFS
  • func NewReadOnlyFS(source hackpadfs.FS, cache writableFS, options ReadOnlyOptions) (*ReadOnlyFS, error)
  • func (fs *ReadOnlyFS) Open(name string) (hackpadfs.File, error)
  • func (fs *ReadOnlyFS) Stat(name string) (hackpadfs.FileInfo, error)
• type ReadOnlyOptions

Types

type ReadOnlyFS

type ReadOnlyFS struct {
	// contains filtered or unexported fields
}

ReadOnlyFS is a read-only cache for an FS. Source FS data must not change. Data is assumed unchanged to increase performance.

func NewReadOnlyFS

func NewReadOnlyFS(source hackpadfs.FS, cache writableFS, options ReadOnlyOptions) (*ReadOnlyFS, error)

NewReadOnlyFS creates a new ReadOnlyFS with the given 'source' of data, a writable 'cache' FS, and any additional options.

func (*ReadOnlyFS) Open

func (fs *ReadOnlyFS) Open(name string) (hackpadfs.File, error)

Open implements hackpadfs.FS

func (*ReadOnlyFS) Stat

func (fs *ReadOnlyFS) Stat(name string) (hackpadfs.FileInfo, error)

Stat implements hackpadfs.StatFS

type ReadOnlyOptions

type ReadOnlyOptions struct {
	RetainData func(name string, info hackpadfs.FileInfo) bool
}

ReadOnlyOptions contain options for creating a ReadOnlyFS