common

package

v4.26.1 Latest Latest Go to latest Published: Jan 29, 2026 License: BSD-3-Clause Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/shirou/gopsutil

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

SPDX-License-Identifier: BSD-3-Clause

Index ¶

Variables
func BootTimeWithContext(ctx context.Context, enableCache bool) (uint64, error)
func ByteToString(orig []byte) string
func CallLsofWithContext(ctx context.Context, invoke Invoker, pid int32, args ...string) ([]string, error)
func GetEnv(key, dfault string, combineWith ...string) string
func GetEnvWithContext(ctx context.Context, key, dfault string, combineWith ...string) string
func GetOSRelease() (platform, version string, err error)
func GetOSReleaseWithContext(ctx context.Context) (platform, version string, err error)
func HexToUint32(hex string) uint32
func HostDev(combineWith ...string) string
func HostDevWithContext(ctx context.Context, combineWith ...string) string
func HostEtc(combineWith ...string) string
func HostEtcWithContext(ctx context.Context, combineWith ...string) string
func HostProc(combineWith ...string) string
func HostProcMountInfoWithContext(ctx context.Context, combineWith ...string) string
func HostProcWithContext(ctx context.Context, combineWith ...string) string
func HostRoot(combineWith ...string) string
func HostRootWithContext(ctx context.Context, combineWith ...string) string
func HostRun(combineWith ...string) string
func HostRunWithContext(ctx context.Context, combineWith ...string) string
func HostSys(combineWith ...string) string
func HostSysWithContext(ctx context.Context, combineWith ...string) string
func HostVar(combineWith ...string) string
func HostVarWithContext(ctx context.Context, combineWith ...string) string
func IntContains(target []int, src int) bool
func IntToString(orig []int8) string
func IsLittleEndian() bool
func NumProcs() (uint64, error)
func NumProcsWithContext(ctx context.Context) (uint64, error)
func PathExists(filename string) bool
func PathExistsWithContents(filename string) bool
func ReadFile(filename string) (string, error)
func ReadInts(filename string) ([]int64, error)
func ReadLine(filename, prefix string) (string, error)
func ReadLines(filename string) ([]string, error)
func ReadLinesOffsetN(filename string, offset uint, n int) ([]string, error)
func Readlink(name string) (string, error)
func Round(val float64, n int) float64
func Sleep(ctx context.Context, interval time.Duration) error
func StringsContains(target []string, src string) bool
func StringsHas(target []string, src string) bool
func UintToString(orig []uint8) string
func Virtualization() (string, string, error)
func VirtualizationWithContext(ctx context.Context) (string, string, error)
type FakeInvoke
- func (i FakeInvoke) Command(name string, arg ...string) ([]byte, error)
- func (i FakeInvoke) CommandWithContext(_ context.Context, name string, arg ...string) ([]byte, error)
type Invoke
- func (i Invoke) Command(name string, arg ...string) ([]byte, error)
- func (Invoke) CommandWithContext(ctx context.Context, name string, arg ...string) ([]byte, error)
type Invoker
type Warnings
- func (w *Warnings) Add(err error)
- func (w *Warnings) Error() string
- func (w *Warnings) Reference() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Timeout                = 3 * time.Second
	ErrNotImplementedError = errors.New("not implemented yet")
	ErrTimeout             = errors.New("command timed out")
)

Functions ¶

func BootTimeWithContext ¶

func BootTimeWithContext(ctx context.Context, enableCache bool) (uint64, error)

func ByteToString ¶

func ByteToString(orig []byte) string

func CallLsofWithContext ¶

func CallLsofWithContext(ctx context.Context, invoke Invoker, pid int32, args ...string) ([]string, error)

func GetEnv ¶

func GetEnv(key, dfault string, combineWith ...string) string

GetEnv retrieves the environment variable key. If it does not exist it returns the default.

func GetEnvWithContext ¶

func GetEnvWithContext(ctx context.Context, key, dfault string, combineWith ...string) string

GetEnvWithContext retrieves the environment variable key. If it does not exist it returns the default. The context may optionally contain a map superseding os.EnvKey.

func GetOSRelease ¶

func GetOSRelease() (platform, version string, err error)

func GetOSReleaseWithContext ¶

func GetOSReleaseWithContext(ctx context.Context) (platform, version string, err error)

func HostDev ¶

func HostDev(combineWith ...string) string

func HostDevWithContext ¶

func HostDevWithContext(ctx context.Context, combineWith ...string) string

func HostEtc ¶

func HostEtc(combineWith ...string) string

func HostEtcWithContext ¶

func HostEtcWithContext(ctx context.Context, combineWith ...string) string

func HostProc ¶

func HostProc(combineWith ...string) string

func HostProcMountInfoWithContext ¶

func HostProcMountInfoWithContext(ctx context.Context, combineWith ...string) string

func HostProcWithContext ¶

func HostProcWithContext(ctx context.Context, combineWith ...string) string

func HostRoot ¶

func HostRoot(combineWith ...string) string

func HostRootWithContext ¶

func HostRootWithContext(ctx context.Context, combineWith ...string) string

func HostRun ¶

func HostRun(combineWith ...string) string

func HostRunWithContext ¶

func HostRunWithContext(ctx context.Context, combineWith ...string) string

func HostSys ¶

func HostSys(combineWith ...string) string

func HostSysWithContext ¶

func HostSysWithContext(ctx context.Context, combineWith ...string) string

func HostVar ¶

func HostVar(combineWith ...string) string

func HostVarWithContext ¶

func HostVarWithContext(ctx context.Context, combineWith ...string) string

func IntContains ¶

func IntContains(target []int, src int) bool

IntContains checks the src in any int of the target int slice.

func IntToString ¶

func IntToString(orig []int8) string

func IsLittleEndian ¶

func IsLittleEndian() bool

IsLittleEndian checks if the current platform uses little-endian. copied from https://github.com/ntrrg/ntgo/blob/v0.8.0/runtime/infrastructure.go#L16 (MIT License)

func NumProcs ¶

func NumProcs() (uint64, error)

func NumProcsWithContext ¶

func NumProcsWithContext(ctx context.Context) (uint64, error)

func PathExists ¶

func PathExists(filename string) bool

func PathExistsWithContents ¶

func PathExistsWithContents(filename string) bool

PathExistsWithContents returns the filename exists and it is not empty

func ReadInts ¶

func ReadInts(filename string) ([]int64, error)

ReadInts reads contents from single line file and returns them as []int32.

func ReadLine ¶

func ReadLine(filename, prefix string) (string, error)

ReadLine reads a file and returns the first occurrence of a line that is prefixed with prefix.

func ReadLines ¶

func ReadLines(filename string) ([]string, error)

ReadLines reads contents from a file and splits them by new lines. A convenience wrapper to ReadLinesOffsetN(filename, 0, -1).

func ReadLinesOffsetN ¶

func ReadLinesOffsetN(filename string, offset uint, n int) ([]string, error)

ReadLinesOffsetN reads contents from file and splits them by new line. The offset tells at which line number to start. The count determines the number of lines to read (starting from offset): n >= 0: at most n lines n < 0: whole file

func Readlink ¶ added in v4.25.6

func Readlink(name string) (string, error)

Readlink behaves like os.Readlink but caches the buffer passed to syscall.Readlink.

func Round ¶ added in v4.24.7

func Round(val float64, n int) float64

Round places rounds the number 'val' to 'n' decimal places

func Sleep ¶

func Sleep(ctx context.Context, interval time.Duration) error

Sleep awaits for provided interval. Can be interrupted by context cancellation.

func StringsContains ¶

func StringsContains(target []string, src string) bool

StringsContains checks the src in any string of the target string slice

func StringsHas ¶

func StringsHas(target []string, src string) bool

StringsHas checks the target string slice contains src or not

func UintToString ¶

func UintToString(orig []uint8) string

func Virtualization ¶

func Virtualization() (string, string, error)

func VirtualizationWithContext ¶

func VirtualizationWithContext(ctx context.Context) (string, string, error)

Types ¶

type FakeInvoke ¶

type FakeInvoke struct {
	Suffix string // Suffix species expected file name suffix such as "fail"
	Error  error  // If Error specified, return the error.
}

func (FakeInvoke) Command ¶

func (i FakeInvoke) Command(name string, arg ...string) ([]byte, error)

Command in FakeInvoke returns from expected file if exists.

func (FakeInvoke) CommandWithContext ¶

func (i FakeInvoke) CommandWithContext(_ context.Context, name string, arg ...string) ([]byte, error)

type Invoke ¶

type Invoke struct{}

func (Invoke) Command ¶

func (i Invoke) Command(name string, arg ...string) ([]byte, error)

func (Invoke) CommandWithContext ¶

func (Invoke) CommandWithContext(ctx context.Context, name string, arg ...string) ([]byte, error)

type Invoker ¶

type Invoker interface {
	Command(string, ...string) ([]byte, error)
	CommandWithContext(context.Context, string, ...string) ([]byte, error)
}

type Warnings ¶

type Warnings struct {
	List []error

	Verbose bool
	// contains filtered or unexported fields
}

func (*Warnings) Add ¶

func (w *Warnings) Add(err error)

func (*Warnings) Error ¶

func (w *Warnings) Error() string

func (*Warnings) Reference ¶

func (w *Warnings) Reference() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL