Struct Config 

pub struct Config {
    pub system: bool,
    pub excluded_packages: Vec<String>,
    pub widgets_id_table: HashMap<String, u64>,
    pub restart: RestartBehavior,
    pub auto_confirm: bool,
    pub threads: Option<usize>,
    pub skip_plasma_detection: bool,
    pub inhibit_idle: bool,
}

Configuration for libplasmoid-updater operations.

This struct contains all configuration options used by the library. Library consumers (like topgrade or other automation tools) can construct this directly without needing config file parsing.

Examples

Basic Configuration

use libplasmoid_updater::Config;

let config = Config::new();

With Custom Settings

use libplasmoid_updater::{Config, RestartBehavior};
use std::collections::HashMap;

let mut widgets_table = HashMap::new();
widgets_table.insert("com.example.widget".to_string(), 123456);

let config = Config::new()
    .with_excluded_packages(vec!["problematic-widget".to_string()])
    .with_widgets_id_table(widgets_table)
    .with_restart(RestartBehavior::Always);

Fields

system: bool

If true, operate on system-wide components (in /usr/share). If false (default), operate on user components (in ~/.local/share). System operations require root privileges.

excluded_packages: Vec<String>

Packages to exclude from updates.

Can match either directory names (e.g., “org.kde.plasma.systemmonitor”) or display names (e.g., “System Monitor”). Components in this list will be skipped during update operations.

widgets_id_table: HashMap<String, u64>

Widget ID fallback table mapping directory names to KDE Store content IDs.

This table is used as a fallback when content ID resolution via KNewStuff registry or exact name matching fails. The library uses a three-tier resolution strategy:

1. KNewStuff registry lookup (most reliable)
2. Exact name match from KDE Store API
3. Fallback to this widgets_id_table

Format

• Key: Component directory name (e.g., “org.kde.plasma.systemmonitor”)
• Value: KDE Store content ID (numeric)

The CLI application loads this from a widgets-id file, but library consumers can provide it programmatically or leave it empty.

restart: RestartBehavior

Controls plasmashell restart behavior after successful updates.

auto_confirm: bool

When true, skip interactive prompts and apply all non-excluded updates automatically. Has no effect without the cli feature.

threads: Option<usize>

Maximum number of parallel installation threads.

None (default) uses the number of logical CPU threads available. Some(n) pins the pool to exactly n threads.

skip_plasma_detection: bool

When true, skip KDE Plasma environment detection and proceed regardless.

inhibit_idle: bool

When true (default), inhibit system idle/sleep/shutdown during installs.

Uses a 3-tier fallback: logind DBus → systemd-inhibit subprocess → no-op. Set to false if the caller handles its own power management inhibition.

Implementations

impl Config

pub fn new() -> Self

Creates a new configuration with default values.

Default values:

• system: false (user components)
• excluded_packages: empty
• widgets_id_table: loaded from embedded widgets-id file
• restart: RestartBehavior::Never

The embedded widgets-id table provides fallback content ID mappings for components that cannot be resolved via KNewStuff registry or exact name matching.

pub fn with_system(self, system: bool) -> Self

Sets whether to operate on system-wide components.

When true, the library scans and updates components in /usr/share instead of ~/.local/share. System operations require root privileges.

Example

use libplasmoid_updater::Config;

let config = Config::new().with_system(true);

pub fn with_widgets_id_table(self, table: HashMap<String, u64>) -> Self

Sets the widgets ID fallback table.

This table maps component directory names to KDE Store content IDs and is used as a fallback when other resolution methods fail.

Arguments

• table - HashMap mapping directory names to content IDs

Example

use libplasmoid_updater::Config;
use std::collections::HashMap;

let mut table = HashMap::new();
table.insert("org.kde.plasma.systemmonitor".to_string(), 998890);

let config = Config::new().with_widgets_id_table(table);

pub fn with_excluded_packages(self, packages: Vec<String>) -> Self

Sets the list of Plasmoids to exclude from updates.

Components in this list will be skipped during updates. The list can contain either directory names or display names.

Arguments

• packages - Vector of package names to exclude

Example

use libplasmoid_updater::Config;

let config = Config::new()
    .with_excluded_packages(vec![
        "org.kde.plasma.systemmonitor".to_string(),
        "Problematic Widget".to_string(),
    ]);

pub fn with_restart(self, restart: RestartBehavior) -> Self

Sets the plasmashell restart behavior after updates.

Example

use libplasmoid_updater::{Config, RestartBehavior};

let config = Config::new().with_restart(RestartBehavior::Always);

pub fn parse_widgets_id(content: &str) -> HashMap<String, u64>

Parses a widgets-id table from a string.

The format is one entry per line: content_id directory_name Lines starting with # are comments.

pub fn with_auto_confirm(self, auto_confirm: bool) -> Self

Sets whether to skip interactive prompts and apply all non-excluded updates automatically.

Has no effect without the cli feature enabled.

Example

use libplasmoid_updater::Config;

let config = Config::new().with_auto_confirm(true);

pub fn with_threads(self, threads: usize) -> Self

Sets the maximum number of parallel installation threads.

By default (None), the library uses the number of logical CPUs. Setting this to a specific value pins the thread pool to exactly that many threads.

Example

use libplasmoid_updater::Config;

let config = Config::new().with_threads(4);

pub fn with_skip_plasma_detection(self, skip: bool) -> Self

Sets whether to skip KDE Plasma environment detection.

When true, the library proceeds without checking for the KNewStuff3 registry directory. Useful for CI, testing, or non-standard KDE setups.

Example

use libplasmoid_updater::Config;

let config = Config::new().with_skip_plasma_detection(true);

pub fn with_inhibit_idle(self, inhibit: bool) -> Self

Sets whether to inhibit system idle/sleep/shutdown during installs.

Defaults to true. Set to false if the calling application handles its own power management inhibition (e.g., a GUI app using DBus directly).

Example

use libplasmoid_updater::Config;

let config = Config::new().with_inhibit_idle(false);
assert!(!config.inhibit_idle);

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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() -> Config

Returns the “default value” for a type.