pub struct Config {
pub schema_version: u32,
pub app_settings: AppSettings,
pub selected_device: Option<String>,
pub devices: BTreeMap<String, DeviceConfig>,
}Expand description
Top-level config document.
Fields§
§schema_version: u32§app_settings: AppSettingsNon-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§
Source§impl Config
impl Config
Sourcepub fn load_or_default() -> Result<Self, ConfigError>
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.
Sourcepub fn load_from_path(path: &Path) -> Result<Self, ConfigError>
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.
Sourcepub fn save_atomic(&self) -> Result<(), ConfigError>
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.
Sourcepub fn save_to_path(&self, path: &Path) -> Result<(), ConfigError>
pub fn save_to_path(&self, path: &Path) -> Result<(), ConfigError>
Same as Self::save_atomic but writes to path. Used by tests.
Sourcepub fn bindings_for(&self, device_key: &str) -> BTreeMap<ButtonId, Action>
pub fn bindings_for(&self, device_key: &str) -> BTreeMap<ButtonId, Action>
Returns the bindings stored for device_key, or an empty map if the
device has no committed bindings yet.
Sourcepub fn set_binding(
&mut self,
device_key: &str,
button: ButtonId,
action: Action,
)
pub fn set_binding( &mut self, device_key: &str, button: ButtonId, action: Action, )
Records action as the binding for button on device_key,
creating the device entry if needed.
Sourcepub fn gesture_bindings_for(
&self,
device_key: &str,
) -> BTreeMap<GestureDirection, Action>
pub fn gesture_bindings_for( &self, device_key: &str, ) -> BTreeMap<GestureDirection, Action>
Returns the gesture sub-bindings stored for device_key, or an empty
map if none are set yet.
Sourcepub fn set_gesture_binding(
&mut self,
device_key: &str,
direction: GestureDirection,
action: Action,
)
pub fn set_gesture_binding( &mut self, device_key: &str, direction: GestureDirection, action: Action, )
Records action for direction of device_key’s gesture button.
Sourcepub fn effective_bindings(
&self,
device_key: &str,
bundle_id: Option<&str>,
) -> BTreeMap<ButtonId, Action>
pub fn effective_bindings( &self, device_key: &str, bundle_id: Option<&str>, ) -> BTreeMap<ButtonId, Action>
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
button_bindings. Per-app values win; 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.
Sourcepub fn set_per_app_binding(
&mut self,
device_key: &str,
bundle_id: &str,
button: ButtonId,
action: Option<Action>,
)
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.
Sourcepub fn selected_device(&self) -> Option<&str>
pub fn selected_device(&self) -> Option<&str>
HID++ config key of the carousel-selected device, if any.
Sourcepub fn set_selected_device(&mut self, key: Option<String>)
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).
Sourcepub fn dpi_presets(&self, device_key: &str) -> Vec<u32>
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.
Sourcepub fn set_dpi_presets(&mut self, device_key: &str, presets: Vec<u32>)
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).