memory

Documentation

Index

• Constants
• type Memory
  • func New(interval time.Duration, fg, bg color.RGBA) *Memory
  • func (m *Memory) HoverText() string
  • func (m *Memory) Name() string
  • func (m *Memory) Render() []module.Segment
  • func (m *Memory) Start(ctx context.Context) <-chan struct{}

Constants

const DefaultIcon = ""

DefaultIcon is the Nerd Font codepoint used when the caller doesn't override Memory.Icon — fae-chip (memory chip).

Types

type Memory

type Memory struct {
	Interval time.Duration
	FG       color.RGBA
	BG       color.RGBA
	Icon     string
	// MeminfoPath overrides /proc/meminfo. Empty means the real procfs
	// path. Tests point this at a fixture file.
	MeminfoPath string
	// contains filtered or unexported fields
}

Memory shows used-memory percentage computed from MemTotal vs MemAvailable in /proc/meminfo (matches what most monitors report).

func New

func New(interval time.Duration, fg, bg color.RGBA) *Memory

func (*Memory) HoverText

func (m *Memory) HoverText() string

HoverText returns a multi-line breakdown: used/total, free, buffers, cached, and swap usage. Implements module.Hoverable.

func (*Memory) Name

func (m *Memory) Name() string

func (*Memory) Render

func (m *Memory) Render() []module.Segment

func (*Memory) Start

func (m *Memory) Start(ctx context.Context) <-chan struct{}