Note: This is a PRE-ALPHA software. API breakage and bugs are expected. Please report them to the issue tracker. Once this is implemented upstream, this crate will be yanked.

GSettings Macro

Macro for easy GSettings key access

The main purpose of this is to reduce the risk of mistyping a key and reduce boilerplate rust code. Furthermore, the summary and the default of the value is included in the documentation of the getter and setter function. This would be helpful if you use rust-analyzer and would encourage documenting GSchema keys.

Schema like the following

<schemalist>
    <schema path="/io/github/seadve/test/" id="io.github.seadve.test">
        <key name="is-maximized" type="b">
            <default>false</default>
            <summary>Window maximized behaviour</summary>
            <description></description>
        </key>
        <key name="theme" type="s">
            <default>"light"</default>
            <summary>Current theme</summary>
            <description></description>
        </key>
        <key name="invalid-words" type="as">
            <default>[]</default>
            <summary>Contains invalid words</summary>
            <description></description>
        </key>
        <key name="window-width" type="i">
            <default>600</default>
            <summary>Window width</summary>
            <description>Window width</description>
        </key>
        <key name="preferred-audio-source" type="s">
            <choices>
                <choice value="microphone"/>
                <choice value="desktop-audio"/>
            </choices>
            <default>"microphone"</default>
            <summary>Preferred audio source to use in recording audio</summary>
            <description></description>
        </key>
    </schema>
</schemalist>

could be accessed with

use gio::prelude::*;

#[gsettings_macro::gen_settings(
    file = "./examples/test.gschema.xml",
    id = "io.github.seadve.test"
)]
pub struct Settings;

let settings = Settings::new();

settings.set_is_maximized(true);
assert!(settings.is_maximized());

settings.set_theme("dark");
assert_eq!(settings.theme(), "dark");

settings.set_invalid_words(&["invalid", "words"]);
assert_eq!(settings.invalid_words(), vec!["invalid", "words"]);

settings.set_window_width(30_000);
assert_eq!(settings.window_width(), 30_000);

settings.set_preferred_audio_source(PreferredAudioSource::DesktopAudio);
assert_eq!(
    settings.preferred_audio_source(),
    PreferredAudioSource::DesktopAudio
);

Usage

gsettings-macro = "0.1.0"

Known issues

• Failing to compile on unknown variants
  • Introduce #[gen_settings_define(signature = "s", ret_type = "String", arg_type = "&str")] etc.
  • Add way to skip generating like #[gen_settings_define(signature ="s", skip)]
• Not updating when the gschema file is modified
  • Use hacks like include_str!

Todos

• Add bind_#key writable, default_#key_value, user_#key_value, reset_#key, connect_#key_writable_changed variant
• Add usage documentation
• Show max and min values in the method docs (e.g. <range min="-1" max="512"/>)
• Add enum and flags support
• Add other common types support (a{ss}, (ss), etc.)