meminfo

package

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

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 meminfo provides an i3bar module that shows memory information.

This section is empty.

This section is empty.

func RefreshInterval(interval time.Duration)

RefreshInterval configures the polling frequency.

type Info map[string]unit.Datasize

Info wraps meminfo output. See /proc/meminfo for names of keys. Some common functions are also provided.

func (i Info) AvailFrac() float64

AvailFrac returns the available memory as a fraction of total.

func (i Info) Available() unit.Datasize

Available returns the "available" system memory, including currently cached memory that can be freed up if needed.

func (i Info) FreeFrac(k string) float64

FreeFrac returns a free/total metric for a given name, e.g. Mem, Swap, High, etc.

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

Module represents a bar.Module that displays memory information.

func New() *Module

New creates a new meminfo module.

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) Stream(s bar.Sink)

Stream subscribes to meminfo and updates the module's output accordingly.