Struct Config 

pub struct Config {

    pub sensors: SensorConfig,
    pub smart: SmartConfig,
    pub btrfs: BtrfsConfig,
    pub lhm: LhmConfig,
    pub ups: UpsConfig,
    pub overview: OverviewConfig,
    pub tui: TuiConfig,
    pub gpu: GpuConfig,
    pub network: NetworkConfig,
    pub alerts: AlertsConfig,
    pub notifications: NotificationsConfig,
    pub updates: UpdatesConfig,
    pub watch: WatchConfig,
    pub hosts: Vec<HostConfig>,
    pub widgets: Vec<WidgetConfig>,
}

Top-level configuration.

Fields

sensors: SensorConfig

Sensor naming and visibility.

smart: SmartConfig

SMART result files.

btrfs: BtrfsConfig

btrfs scrub status files.

lhm: LhmConfig

LibreHardwareMonitor’s web server, the source of temperatures, fans and CPU power on Windows.

ups: UpsConfig

Network UPS Tools’ upsd, the source of UPS readings.

overview: OverviewConfig

The multi-host overview.

tui: TuiConfig

The terminal UI.

gpu: GpuConfig

GPU panels and overview cards.

network: NetworkConfig

The network panel.

alerts: AlertsConfig

When a reading becomes an alert.

notifications: NotificationsConfig

Desktop notifications for new alerts (GUI).

updates: UpdatesConfig

Looking for new rigtop releases.

watch: WatchConfig

Alerts sent by rigtop --watch.

hosts: Vec<HostConfig>

Remote hosts monitored over SSH ([[hosts]] tables).

widgets: Vec<WidgetConfig>

Extra panels beside the monitor ([[widgets]] tables).

Implementations

impl Config

pub fn default_path() -> Option<PathBuf>

Default path of the configuration file, if the platform has a config directory. From the Microsoft Store’s package, the package’s LocalState folder (see crate::package).

pub fn load(path: &Path) -> Result<Self, ConfigError>

Loads the configuration from path. A missing file yields the defaults.

pub fn alerts_for(&self, host: &HostConfig) -> Result<AlertsConfig, Error>

The alert thresholds of host: [alerts] with the keys of the host’s own alerts table in place of its own.

pub fn load_default() -> Result<Self, ConfigError>

Loads from Config::default_path, or returns the defaults when the platform has no config directory.

pub fn save(&self, path: &Path) -> Result<(), ConfigError>

Writes the configuration to path, creating parent directories.

The file is written to a temporary sibling and renamed into place, so a crash never leaves a truncated config behind.

pub fn save_hosts(path: &Path, hosts: &[HostConfig]) -> Result<(), ConfigError>

Replaces the [[hosts]] of the configuration file at path with hosts, keeping everything else in the file (other settings, comments, formatting) untouched. Creates the file if needed.

Used by the GUI’s host editor. The edited file is checked to load as a valid configuration before it replaces the old one.

pub fn save_tui(path: &Path, tui: &TuiConfig) -> Result<(), ConfigError>

Replaces the sensor names and hidden sensors ([sensors]) of the configuration file at path, keeping the rest of the file as it is, like Config::save_hosts. Names stay an inline table if they were one.

Used by the GUI’s sensor editor. Writes [tui] (keys left at their defaults are removed), leaving the rest of the file as it is.

pub fn save_sensors( path: &Path, sensors: &SensorConfig, ) -> Result<(), ConfigError>

pub fn fan_label<'a>(&'a self, fan: &'a Fan) -> &'a str

Display name of a fan: the user-defined label, or the driver/generic label.

pub fn temperature_label<'a>(&'a self, temperature: &'a Temperature) -> &'a str

Display name of a temperature channel.

pub fn label_for(&self, key: &str) -> Option<&str>

User-defined label for a channel key, if any.

pub fn set_label(&mut self, key: &str, name: &str)

Sets (or, with an empty name, removes) the label of a channel.

pub fn is_hidden(&self, key: &str) -> bool

Whether the user chose to hide a channel.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config