Struct Config 

pub struct Config {
    pub schema_version: u32,
    pub app_settings: AppSettings,
    pub selected_device: Option<String>,
    pub devices: BTreeMap<String, DeviceConfig>,
}

Top-level config document.

Fields

schema_version: u32

app_settings: AppSettings

Non-device-scoped preferences (autostart, tray, language, …).

selected_device: Option<String>

HID++ config_key of the carousel-selected device, persisted so a restart restores the last view rather than always landing on the first paired device. None means “fall back to the first device”.

devices: BTreeMap<String, DeviceConfig>

Implementations

impl Config

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

Loads the config from the default user path, returning Config::default if the file does not exist yet.

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

Same as Self::load_or_default but reads from path. Used by tests to avoid touching the real user config.

pub fn save_atomic(&self) -> Result<(), ConfigError>

Writes the config atomically to the default user path: serialize to a sibling temp file, then rename over the target. On Unix the temp file is created with mode 0600.

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

Same as Self::save_atomic but writes to path. Used by tests.

pub fn bindings_for(&self, device_key: &str) -> BTreeMap<ButtonId, Binding>

Returns the bindings stored for device_key, or an empty map if the device has no committed bindings yet.

pub fn set_binding( &mut self, device_key: &str, button: ButtonId, binding: Binding, )

Records binding for button on device_key, creating the device entry if needed. Replaces the whole binding (use Self::set_gesture_direction to edit one direction of a gesture binding in place).

pub fn gesture_bindings_for( &self, device_key: &str, ) -> BTreeMap<GestureDirection, Action>

Returns the gesture sub-bindings for device_key’s gesture button, or an empty map if it isn’t in gesture mode. Derived from the unified DeviceConfig::bindings; kept as a convenience for the agent-side per-direction adapter.

pub fn set_gesture_direction( &mut self, device_key: &str, button: ButtonId, direction: GestureDirection, action: Action, )

Records action for one direction of button’s gesture binding, creating the device entry if needed.

A button with no binding yet is seeded from its canonical default_binding_for — for ButtonId::GestureButton that is the full default direction map (including a GestureDirection::Click), so the merged map never persists a gesture binding whose click projection is a no-op. A prior Binding::Single is upgraded to Binding::Gesture, preserving its action as the Click entry.

pub fn gesture_owner(&self, device_key: &str) -> Option<ButtonId>

The button that owns device_key’s single gesture role, or None when gestures are turned off.

Resolved from the explicit DeviceConfig::gesture_owner when present; otherwise inferred (see Self::infer_gesture_owner) for configs predating the field and freshly-migrated pre-v2 files. The dedicated thumb pad (ButtonId::GestureButton) owns the role by default. At most one button gestures per device.

pub fn set_gesture_owner(&mut self, device_key: &str, button: ButtonId)

Make button the device’s sole gesture button.

Records button as the explicit gesture_owner, so the one-gesture-button-per-device lock is a data-model fact rather than a destructive demotion of the others — every other gesture-capable button keeps its own gesture map intact, ready to restore if re-chosen, and is simply not dispatched while it isn’t the owner. button is given a full Binding::Gesture map: a prior Binding::Single is kept as the GestureDirection::Click action, any existing swipe arms are preserved, and unbound directions are seeded from [default_gesture_binding] so every gesture button exposes the same full five-direction set.

pub fn disable_gestures(&mut self, device_key: &str)

Turn gestures off for device_key, recording the explicit “off” choice. Every button keeps its gesture map intact (nothing is destroyed), so re-selecting a gesture owner later restores its directions exactly.

pub fn effective_bindings( &self, device_key: &str, bundle_id: Option<&str>, ) -> BTreeMap<ButtonId, Binding>

Resolve the effective binding map for device_key, overlaying the per-app entry for bundle_id (if any) on top of the global per-device bindings. A per-app override replaces the whole button with a Binding::Single; everything else falls through.

Returns an empty map when the device has no recorded bindings yet. Callers (the GUI / hook) layer their own defaults on top.

pub fn set_per_app_binding( &mut self, device_key: &str, bundle_id: &str, button: ButtonId, action: Option<Action>, )

Records a per-app override. Creates the device + app entries as needed; passing an action of None removes the override and prunes the empty app map.

pub fn selected_device(&self) -> Option<&str>

HID++ config key of the carousel-selected device, if any.

pub fn set_selected_device(&mut self, key: Option<String>)

Update the carousel-selected device. Pass None to clear the selection (e.g. when the previously-selected device disappears).

pub fn dpi_presets(&self, device_key: &str) -> Vec<u32>

The ordered DPI preset list for device_key, or an empty Vec if the device has none configured yet.

pub fn set_dpi_presets(&mut self, device_key: &str, presets: Vec<u32>)

Replace the DPI preset list for device_key. Pass an empty Vec to clear (the device block is kept; the field is just omitted on save thanks to skip_serializing_if).

pub fn device_identity(&self, device_key: &str) -> Option<&DeviceIdentity>

The last-known DeviceIdentity for device_key, or None if the device has never been seen online (or was configured before identities were recorded).

pub fn set_device_identity( &mut self, device_key: &str, identity: DeviceIdentity, )

Record (or refresh) the identity captured for device_key while it was online, creating the device entry if needed.

pub fn known_identities(&self) -> impl Iterator<Item = (&str, &DeviceIdentity)>

Iterate every device we’ve recorded an identity for, as (config_key, identity). Used to seed offline placeholder cards so a known device stays visible (with its panels) before any live probe.

pub fn lighting(&self, device_key: &str) -> Option<Lighting>

The lighting config for device_key, or None if unset.

pub fn set_lighting(&mut self, device_key: &str, lighting: Lighting)

Replace the lighting config for device_key.

pub fn dpi(&self, device_key: &str) -> Option<u32>

The committed sensor DPI for device_key, or None if never set.

pub fn set_dpi(&mut self, device_key: &str, dpi: u32)

Record the committed sensor DPI for device_key, so the agent can re-apply it when the device reconnects (#189).

pub fn smartshift(&self, device_key: &str) -> Option<SmartShift>

The SmartShift wheel config for device_key, or None if never set.

pub fn set_smartshift(&mut self, device_key: &str, smartshift: SmartShift)

Record the SmartShift wheel config for device_key, so the agent can re-apply it when the device reconnects (#189).

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

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.