util

Documentation

Overview

Package util provides miscellaneous utility functions.

Index

• func BeNice(priority int) error
• func Extract(pathname string, content []byte, data any) error
• func IsTTY(f *os.File) bool
• func LogRecover()
• type CommandLogger
  • func (cl *CommandLogger) Close() error
  • func (cl *CommandLogger) Write(data []byte) (n int, err error)
• type Woke
  • func StartWokeWatch(delay time.Duration, diffMin time.Duration, onWake WokeFunc) *Woke
  • func (w *Woke) Stop()
• type WokeFunc

Functions

func BeNice

func BeNice(priority int) error

BeNice lets a Unix process reduce its own execution priority to avoid impacting other processes. Positive values have lower privilege (are nicer) while negative values have a higher privilege (are MEAN!).

func Extract

func Extract(pathname string, content []byte, data any) error

func IsTTY

func IsTTY(f *os.File) bool

IsTTY determines if a file handle is attached to a TTY.

func LogRecover

func LogRecover()

LogRecover helps ensure any unhandled errors are logged. Useful as a `defer` function immediately upon entering a goroutine.

Types

type CommandLogger

type CommandLogger struct {
	Log func(string)
	// contains filtered or unexported fields
}

CommandLogger is used when newline-terminated output should be logged (e.g. from exec.Command).

func (*CommandLogger) Close

func (cl *CommandLogger) Close() error

Close implments io.WriteCloser by flushing any remaining string in the local buffer out to the logger and resets the buffer.

func (*CommandLogger) Write

func (cl *CommandLogger) Write(data []byte) (n int, err error)

Write implements io.Writer by buffering locally and logging each newline-terminated string found in the buffer.

type Woke

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

Woke is a utility to help know when a process was suspended for some amount of time.

func StartWokeWatch

func StartWokeWatch(delay time.Duration, diffMin time.Duration, onWake WokeFunc) *Woke

StartWokeWatch begins watching for conditions indicating when a time lapse has occurred. It will invoke onWake when the time difference detected is larger than diffMin, checking for lapses once every delay.

func (*Woke) Stop

func (w *Woke) Stop()

Stop will terminate the watcher (if running).

type WokeFunc

type WokeFunc func(diff time.Duration)

WokeFunc is the callback invoked when a time lapse is detected.