GSettings Macro

Macro for typesafe GSettings key access

The macro's main purpose is to reduce the risk of mistyping a key, using the wrong method to access values, inputing incorrect values, and reduce boilerplate. Additionally, the summary, the description, and the default of the value are included in the documentation of each generated methods. This would be beneficial if you use tools like rust-analyzer.

Example

use gsettings_macro::gen_settings;

use std::path::{Path, PathBuf};

#[gen_settings(
    file = "./tests/io.github.seadve.test.gschema.xml",
    id = "io.github.seadve.test"
)]
#[gen_settings_define(
    key_name = "cache-dir",
    arg_type = "&Path",
    ret_type = "PathBuf"
)]
#[gen_settings_skip(signature = "ay")]
pub struct ApplicationSettings;

let settings = ApplicationSettings::default();

// `i` DBus type
settings.set_window_width(100);
assert_eq!(settings.window_width(), 100)

// enums
settings.set_alert_sound(AlertSound::Glass);
assert_eq!(settings.alert_sound(), AlertSound::Glass);

// bitflags
settings.set_space_style(SpaceStyle::BEFORE_COLON | SpaceStyle::BEFORE_COMMA);
assert_eq!(
    settings.space_style(),
    SpaceStyle::BEFORE_COLON | SpaceStyle::BEFORE_COMMA
);

// customly defined
settings.set_cache_dir(Path::new("/some_dir/"));
assert_eq!(settings.cache_dir(), PathBuf::from("/some_dir/"));

For more examples and detailed information see the documentation.

Generated methods

The procedural macro generates code for each key for following gio::Settings methods:

• set -> set_#key, which panics when writing in a readonly key, and try_set_#key, which behaves the same as the original method.
• get -> get_#key
• connect_changed -> connect_#key_changed
• bind -> bind_#key
• create_action -> create_#key_action

Known issues

• Not updating when the gschema file is modified
  • Use hacks like include_str!
  • See https://github.com/rust-lang/rust/issues/73921 or https://github.com/rust-lang/rust/issues/55904

Todos

• Remove serde dependency
• Add way to map setter and getters value
• Add bind_#key writable, user_#key_value, reset_#key, connect_#key_writable_changed variants