freeze

package

v0.8.28 Latest Latest Go to latest Published: Apr 7, 2024 License: Apache-2.0, MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

This section is empty.

This section is empty.

func Unfreeze(ctx context.Context, dirPaths []string, freezeAtPercent float64, dstore datastore.Datastore) error

Unfreeze explicitly triggers the indexer to exit frozen mode.

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

Freezer monitors disk usage and triggers a freeze if the usage reaches a specified threshold.

func New(dirPaths []string, freezeAtPercent float64, dstore datastore.Datastore, freezeFunc func() error) (*Freezer, error)

New creates a new Freezer that checks the usage of the file system at dirPath.

func (f *Freezer) CheckNow() bool

CheckNow triggers an immediate disk usage check.

func (f *Freezer) Close()

Close stops the goroutine that checks disk usage.

func (f *Freezer) Dirs() []string

Dirs returns the directories being monitored.

func (f *Freezer) Freeze() error

Freeze manually triggers the indexer to enter frozen mode.

func (f *Freezer) Frozen() bool

Frozen returns true if indexer is frozen.

func (f *Freezer) Usage() (*disk.UsageStats, error)

Usage returns the disk usage of the most used directory.