diskspace

package

v0.0.0-...-c936f35 Latest Latest Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 9 Imported by: 19

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

Package diskspace provides an i3bar module for disk space usage.

This section is empty.

This section is empty.

This section is empty.

type Info struct {
	Available unit.Datasize
	Free      unit.Datasize
	Total     unit.Datasize
}

Info wraps disk space information.

func (i Info) AvailFrac() float64

AvailFrac returns the fraction of disk space available for use.

func (i Info) AvailPct() int

AvailPct returns the percentage of disk space available for use.

func (i Info) Used() unit.Datasize

Used returns the disk space currently in use.

func (i Info) UsedFrac() float64

UsedFrac returns the fraction of disk space currently in use.

func (i Info) UsedPct() int

UsedPct returns the percentage of disk space currently in use.

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

Module represents a diskspace bar module. It supports setting the output format, click handler, update frequency, and urgency/colour functions.

func New(path string) *Module

New constructs an instance of the diskusage module for the given disk path.

func (m *Module) Output(outputFunc func(Info) bar.Output) *Module

Output configures a module to display the output of a user-defined function.

func (m *Module) RefreshInterval(interval time.Duration) *Module

RefreshInterval configures the polling frequency for statfs.

func (m *Module) Stream(s bar.Sink)

Stream starts the module.