netinfo

package

v0.0.0-...-cb77e8e Latest Latest Go to latest Published: Oct 7, 2019 License: Apache-2.0 Imports: 5 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

Package netinfo provides an i3bar module for network information.

This section is empty.

This section is empty.

This section is empty.

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

Module represents a netinfo bar module.

func Interface(iface string) *Module

Interface constructs an instance of the netinfo module restricted to the specified interface.

func New() *Module

New constructs a netinfo module that scans all interfaces.

func Prefix(prefix string) *Module

Prefix constructs an instance of the netinfo module restricted to interfaces with the given prefix.

func (m *Module) Output(outputFunc func(State) 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.

type State struct {
	netlink.Link
}

State represents the network state.

func (s State) Connected() bool

Connected returns true if connected to a network.

func (s State) Connecting() bool

Connecting returns true if a connection is in progress.

func (s State) Enabled() bool

Enabled returns true if a network interface is enabled.