diskio

package

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

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 diskio implements an i3bar module to show disk IO rates.

This section is empty.

This section is empty.

func RefreshInterval(interval time.Duration)

RefreshInterval configures the polling frequency.

type IO struct {
	Input, Output unit.Datarate
	// contains filtered or unexported fields
}

IO represents input and output rates for a disk.

func (i IO) Total() unit.Datarate

Total gets the total IO rate (input + output).

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

Module represents a bar.Module for a single disk's io activity.

func New(disk string) *Module

New creates a diskio module that displays disk io rates for the given disk.

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

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

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

Stream starts the module. Note that diskio updates begin as soon as the first module is constructed, even if no modules are streaming.