modules

Documentation

Index

• type Backlight
  • func (b Backlight) GetPrefix() string
  • func (b Backlight) GetSuffix() string
  • func (b Backlight) Print(args []string) string
• type Battery
  • func (b Battery) GetPrefix() string
  • func (b Battery) GetSuffix() string
  • func (b Battery) Print(args []string) string
• type Custom
  • func (c Custom) GetPrefix() string
  • func (c Custom) GetSuffix() string
  • func (c Custom) Print(args []string) string
• type Date
  • func (d Date) GetPrefix() string
  • func (d Date) GetSuffix() string
  • func (d Date) Print(args []string) string
• type IP
  • func (ip IP) GetPrefix() string
  • func (ip IP) GetSuffix() string
  • func (ip IP) Print(args []string) string
• type Module
• type Music
  • func (m Music) GetPrefix() string
  • func (m Music) GetSuffix() string
  • func (m Music) Print(args []string) string
• type PulseAudio
  • func (pa PulseAudio) GetPrefix() string
  • func (pa PulseAudio) GetSuffix() string
  • func (pa PulseAudio) Print(args []string) string
• type Ram
  • func (r Ram) GetPrefix() string
  • func (r Ram) GetSuffix() string
  • func (r Ram) Print(args []string) string
• type Storage
  • func (s Storage) GetPrefix() string
  • func (s Storage) GetSuffix() string
  • func (s Storage) Print(args []string) string
• type Temperature
  • func (t Temperature) GetPrefix() string
  • func (t Temperature) GetSuffix() string
  • func (t Temperature) Print(args []string) string
• type Uptime
  • func (u Uptime) GetPrefix() string
  • func (u Uptime) GetSuffix() string
  • func (u Uptime) Print(args []string) string

Types

type Backlight

type Backlight struct {
	Prefix string
	Suffix string
	Device string
	Format string
}

func (Backlight) GetPrefix

func (b Backlight) GetPrefix() string

func (Backlight) GetSuffix

func (b Backlight) GetSuffix() string

func (Backlight) Print

func (b Backlight) Print(args []string) string

type Battery

type Battery struct {
	Prefix          string
	Suffix          string
	BatteryName     string `yaml:"battery_name"`
	ChargingText    string `yaml:"charging_text"`
	DischargingText string `yaml:"discharging_text"`
	Rounding        int
	Format          string
}

func (Battery) GetPrefix

func (b Battery) GetPrefix() string

func (Battery) GetSuffix

func (b Battery) GetSuffix() string

func (Battery) Print

func (b Battery) Print(args []string) string

type Custom

type Custom struct {
	Prefix  string
	Suffix  string
	Command string
}

func (Custom) GetPrefix

func (c Custom) GetPrefix() string

func (Custom) GetSuffix

func (c Custom) GetSuffix() string

func (Custom) Print

func (c Custom) Print(args []string) string

type Date

type Date struct {
	Prefix string
	Suffix string
	Format string
}

func (Date) GetPrefix

func (d Date) GetPrefix() string

func (Date) GetSuffix

func (d Date) GetSuffix() string

func (Date) Print

func (d Date) Print(args []string) string

type IP

type IP struct {
	Prefix    string
	Suffix    string
	Interface []string
	NoIp      string `yaml:"no_ip"`
}

func (IP) GetPrefix

func (ip IP) GetPrefix() string

func (IP) GetSuffix

func (ip IP) GetSuffix() string

func (IP) Print

func (ip IP) Print(args []string) string

*

• @TODO: Support IPv6, flag in the config to choose which to display

type Module

type Module interface {
	Print(args []string) string
	GetPrefix() string
	GetSuffix() string
}

type Music

type Music struct {
	Prefix   string
	Suffix   string
	Format   string
	NoPlayer string `yaml:"no_player"`
	TrimAt   int    `yaml:"trim_at"`
	TrimAll  int    `yaml:"trim_all"`
	Players  []string
}

func (Music) GetPrefix

func (m Music) GetPrefix() string

func (Music) GetSuffix

func (m Music) GetSuffix() string

func (Music) Print

func (m Music) Print(args []string) string

type PulseAudio

type PulseAudio struct {
	Prefix         string
	Suffix         string
	Names          []string
	Type           string
	Format         string
	NotFoundFormat string `yaml:"not_found_format"`
	MutedFormat    string `yaml:"muted_format"`
}

func (PulseAudio) GetPrefix

func (pa PulseAudio) GetPrefix() string

func (PulseAudio) GetSuffix

func (pa PulseAudio) GetSuffix() string

func (PulseAudio) Print

func (pa PulseAudio) Print(args []string) string

type Ram

type Ram struct {
	Prefix   string
	Suffix   string
	Format   string
	Rounding int
	Unit     string
}

func (Ram) GetPrefix

func (r Ram) GetPrefix() string

func (Ram) GetSuffix

func (r Ram) GetSuffix() string

func (Ram) Print

func (r Ram) Print(args []string) string

type Storage

type Storage struct {
	Prefix     string
	Suffix     string
	Format     string
	MountPoint string `yaml:"mount_point"`
	Rounding   int
	Unit       string
}

func (Storage) GetPrefix

func (s Storage) GetPrefix() string

func (Storage) GetSuffix

func (s Storage) GetSuffix() string

func (Storage) Print

func (s Storage) Print(args []string) string

type Temperature

type Temperature struct {
	Prefix string
	Suffix string

	Unit     string
	Rounding int
	JsonPath string `yaml:"json_path"`
}

func (Temperature) GetPrefix

func (t Temperature) GetPrefix() string

func (Temperature) GetSuffix

func (t Temperature) GetSuffix() string

func (Temperature) Print

func (t Temperature) Print(args []string) string

type Uptime

type Uptime struct {
	Prefix          string
	Suffix          string
	Format          string
	NoMinutesFormat string `yaml:"no_minutes_format"`
	NoHoursFormat   string `yaml:"no_hours_format"`
	TwoDigitHours   bool   `yaml:"two_digit_hours"`
}

func (Uptime) GetPrefix

func (u Uptime) GetPrefix() string

func (Uptime) GetSuffix

func (u Uptime) GetSuffix() string

func (Uptime) Print

func (u Uptime) Print(args []string) string