cache

package

Go to main page

Versions in this module

v1

v1.2.3

Jul 28, 2025

v1.2.2

Mar 15, 2025

v1.2.1

Mar 14, 2025

v1.1.1

Feb 7, 2025

v1.1.0

Feb 7, 2025

v1.0.1

Feb 7, 2025

v0

v0.1.0

Oct 21, 2024

Changes in this version

+ const BackgroundUploadCompleted — darwin/amd64, linux/amd64, windows/amd64

+ const BackgroundUploadError — darwin/amd64, linux/amd64, windows/amd64

+ const BackgroundUploadStarted — darwin/amd64, linux/amd64, windows/amd64

+ const DataTsBucket — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheChunkCleanInterval — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheChunkNoMemory — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheChunkSize — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheDbWaitTime — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheInfoAge — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheReadRetries — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheRps — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheTmpWaitTime — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheTotalChunkSize — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheTotalWorkers — darwin/amd64, linux/amd64, windows/amd64

+ const DefCacheWrites — darwin/amd64, linux/amd64, windows/amd64

+ const RootBucket — darwin/amd64, linux/amd64, windows/amd64

+ const RootTsBucket — darwin/amd64, linux/amd64, windows/amd64

+ func NewFs(ctx context.Context, name, rootPath string, m configmap.Mapper) (fs.Fs, error) — darwin/amd64, linux/amd64, windows/amd64

+ type BackgroundUploadState struct — darwin/amd64, linux/amd64, windows/amd64

+ Error error

+ Remote string

+ Status int

+ type Directory struct — darwin/amd64, linux/amd64, windows/amd64

+ CacheFs *Fs

+ CacheItems int64

+ CacheModTime int64

+ CacheSize int64

+ CacheTs *time.Time

+ CacheType string

+ Dir string

+ Directory fs.Directory

+ Name string

+ func DirectoryFromOriginal(ctx context.Context, f *Fs, d fs.Directory) *Directory

+ func NewDirectory(f *Fs, remote string) *Directory

+ func ShallowDirectory(f *Fs, remote string) *Directory

+ func (d *Directory) Fs() fs.Info

+ func (d *Directory) ID() string

+ func (d *Directory) Items() int64

+ func (d *Directory) ModTime(ctx context.Context) time.Time

+ func (d *Directory) Remote() string

+ func (d *Directory) Size() int64

+ func (d *Directory) String() string

+ type Features struct — darwin/amd64, linux/amd64, windows/amd64

+ DbWaitTime time.Duration

+ PurgeDb bool

+ type Fs struct — darwin/amd64, linux/amd64, windows/amd64

+ func (f *Fs) About(ctx context.Context) (*fs.Usage, error)

+ func (f *Fs) ChangeNotify(ctx context.Context, notifyFunc func(string, fs.EntryType), ...)

+ func (f *Fs) ChunkSize() int64

+ func (f *Fs) CleanUp(ctx context.Context) error

+ func (f *Fs) CleanUpCache(ignoreLastTs bool)

+ func (f *Fs) Command(ctx context.Context, name string, arg []string, opt map[string]string) (interface{}, error)

+ func (f *Fs) Copy(ctx context.Context, src fs.Object, remote string) (fs.Object, error)

+ func (f *Fs) DirCacheFlush()

+ func (f *Fs) DirMove(ctx context.Context, src fs.Fs, srcRemote, dstRemote string) error

+ func (f *Fs) Disconnect(ctx context.Context) error

+ func (f *Fs) Features() *fs.Features

+ func (f *Fs) GetBackgroundUploadChannel() chan BackgroundUploadState

+ func (f *Fs) Hashes() hash.Set

+ func (f *Fs) InfoAge() time.Duration

+ func (f *Fs) List(ctx context.Context, dir string) (entries fs.DirEntries, err error)

+ func (f *Fs) ListR(ctx context.Context, dir string, callback fs.ListRCallback) (err error)

+ func (f *Fs) MergeDirs(ctx context.Context, dirs []fs.Directory) error

+ func (f *Fs) Mkdir(ctx context.Context, dir string) error

+ func (f *Fs) Move(ctx context.Context, src fs.Object, remote string) (fs.Object, error)

+ func (f *Fs) Name() string

+ func (f *Fs) NewObject(ctx context.Context, remote string) (fs.Object, error)

+ func (f *Fs) Purge(ctx context.Context, dir string) error

+ func (f *Fs) Put(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

+ func (f *Fs) PutStream(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

+ func (f *Fs) PutUnchecked(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

+ func (f *Fs) Rmdir(ctx context.Context, dir string) error

+ func (f *Fs) Root() string

+ func (f *Fs) SetWrapper(wrapper fs.Fs)

+ func (f *Fs) Shutdown(ctx context.Context) error

+ func (f *Fs) Stats() (map[string]map[string]interface{}, error)

+ func (f *Fs) StopBackgroundRunners()

+ func (f *Fs) String() string

+ func (f *Fs) TempUploadWaitTime() time.Duration

+ func (f *Fs) UnWrap() fs.Fs

+ func (f *Fs) UserInfo(ctx context.Context) (map[string]string, error)

+ func (f *Fs) WrapFs() fs.Fs

+ type Handle struct — darwin/amd64, linux/amd64, windows/amd64

+ UseMemory bool

+ func NewObjectHandle(ctx context.Context, o *Object, cfs *Fs) *Handle

+ func (r *Handle) Close() error

+ func (r *Handle) Read(p []byte) (n int, err error)

+ func (r *Handle) Seek(offset int64, whence int) (int64, error)

+ func (r *Handle) String() string

+ type Memory struct — darwin/amd64, linux/amd64, windows/amd64

+ func NewMemory(defaultExpiration time.Duration) *Memory

+ func (m *Memory) AddChunk(fp string, data []byte, offset int64) error

+ func (m *Memory) AddChunkAhead(fp string, data []byte, offset int64, t time.Duration) error

+ func (m *Memory) CleanChunksByAge(chunkAge time.Duration)

+ func (m *Memory) CleanChunksByNeed(offset int64)

+ func (m *Memory) CleanChunksBySize(maxSize int64)

+ func (m *Memory) Connect(defaultExpiration time.Duration) error

+ func (m *Memory) GetChunk(cachedObject *Object, offset int64) ([]byte, error)

+ func (m *Memory) HasChunk(cachedObject *Object, offset int64) bool

+ type NotificationContainer struct — darwin/amd64, linux/amd64, windows/amd64

+ PlaySessionState []PlaySessionStateNotification

+ Size int

+ Type string

+ type Object struct — darwin/amd64, linux/amd64, windows/amd64

+ CacheFs *Fs

+ CacheHashes map[hash.Type]string

+ CacheModTime int64

+ CacheSize int64

+ CacheStorable bool

+ CacheTs time.Time

+ CacheType string

+ Dir string

+ Name string

+ ParentFs fs.Fs

+ func NewObject(f *Fs, remote string) *Object

+ func ObjectFromOriginal(ctx context.Context, f *Fs, o fs.Object) *Object

+ func (o *Object) Fs() fs.Info

+ func (o *Object) Hash(ctx context.Context, ht hash.Type) (string, error)

+ func (o *Object) ModTime(ctx context.Context) time.Time

+ func (o *Object) Open(ctx context.Context, options ...fs.OpenOption) (io.ReadCloser, error)

+ func (o *Object) Remote() string

+ func (o *Object) Remove(ctx context.Context) error

+ func (o *Object) SetModTime(ctx context.Context, t time.Time) error

+ func (o *Object) Size() int64

+ func (o *Object) Storable() bool

+ func (o *Object) String() string

+ func (o *Object) UnWrap() fs.Object

+ func (o *Object) Update(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) error

+ type Options struct — darwin/amd64, linux/amd64, windows/amd64

+ ChunkCleanInterval fs.Duration

+ ChunkNoMemory bool

+ ChunkPath string

+ ChunkSize fs.SizeSuffix

+ ChunkTotalSize fs.SizeSuffix

+ DbPath string

+ DbPurge bool

+ DbWaitTime fs.Duration

+ InfoAge fs.Duration

+ PlexInsecure bool

+ PlexPassword string

+ PlexToken string

+ PlexURL string

+ PlexUsername string

+ ReadRetries int

+ Remote string

+ Rps int

+ StoreWrites bool

+ TempWaitTime fs.Duration

+ TempWritePath string

+ TotalWorkers int

+ type Persistent struct — darwin/amd64, linux/amd64, windows/amd64

+ func GetPersistent(dbPath, chunkPath string, f *Features) (*Persistent, error)

+ func (b *Persistent) AddBatchDir(cachedDirs []*Directory) error

+ func (b *Persistent) AddChunk(fp string, data []byte, offset int64) error

+ func (b *Persistent) AddDir(cachedDir *Directory) error

+ func (b *Persistent) AddObject(cachedObject *Object) error

+ func (b *Persistent) CleanChunksByAge(chunkAge time.Duration)

+ func (b *Persistent) CleanChunksByNeed(offset int64)

+ func (b *Persistent) CleanChunksBySize(maxSize int64)

+ func (b *Persistent) Close()

+ func (b *Persistent) ExpireDir(cd *Directory) error

+ func (b *Persistent) ExpireObject(co *Object, withData bool) error

+ func (b *Persistent) GetChunk(cachedObject *Object, offset int64) ([]byte, error)

+ func (b *Persistent) GetChunkTs(path string, offset int64) (time.Time, error)

+ func (b *Persistent) GetDir(remote string) (*Directory, error)

+ func (b *Persistent) GetDirEntries(cachedDir *Directory) (fs.DirEntries, error)

+ func (b *Persistent) GetObject(cachedObject *Object) (err error)

+ func (b *Persistent) HasChunk(cachedObject *Object, offset int64) bool

+ func (b *Persistent) HasEntry(remote string) bool

+ func (b *Persistent) Purge()

+ func (b *Persistent) ReconcileTempUploads(ctx context.Context, cacheFs *Fs) error

+ func (b *Persistent) RemoveDir(fp string) error

+ func (b *Persistent) RemoveObject(fp string) error

+ func (b *Persistent) SearchPendingUpload(remote string) (started bool, err error)

+ func (b *Persistent) Stats() (map[string]map[string]interface{}, error)

+ func (b *Persistent) String() string

+ type PlaySessionStateNotification struct — darwin/amd64, linux/amd64, windows/amd64

+ GUID string

+ Key string

+ SessionKey string

+ State string

+ TranscodeSession string

+ ViewOffset int64

+ type PlexNotification struct — darwin/amd64, linux/amd64, windows/amd64

+ Container NotificationContainer

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