libfeedback 0.0.1

Rust bindings for libfeedback
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT

use glib::translate::*;

/// Get the application id set via [`Event::set_app_id()`][crate::Event::set_app_id()].
///
/// # Returns
///
/// the application id.
#[doc(alias = "lfb_get_app_id")]
#[doc(alias = "get_app_id")]
pub fn app_id() -> glib::GString {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::lfb_get_app_id()) }
}

/// Gets the currently set feedback profile.
///
/// # Returns
///
/// The current profile or [`None`] on error.
#[doc(alias = "lfb_get_feedback_profile")]
#[doc(alias = "get_feedback_profile")]
pub fn feedback_profile() -> glib::GString {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::lfb_get_feedback_profile()) }
}

//#[doc(alias = "lfb_get_proxy")]
//#[doc(alias = "get_proxy")]
//pub fn proxy() -> /*Ignored*/GdbusFeedback {
//    unsafe { TODO: call ffi:lfb_get_proxy() }
//}

/// Initialize libfeedback. This must be called before any other of libfeedback's functions.
/// ## `app_id`
/// The application id
///
/// # Returns
///
/// [`true`] if successful, or [`false`] on error.
#[doc(alias = "lfb_init")]
pub fn init(app_id: &str) -> Result<(), glib::Error> {
    assert_initialized_main_thread!();
    unsafe {
        let mut error = std::ptr::null_mut();
        let is_ok = ffi::lfb_init(app_id.to_glib_none().0, &mut error);
        debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
        if error.is_null() {
            Ok(())
        } else {
            Err(from_glib_full(error))
        }
    }
}

/// Gets whether or not libfeedback is initialized.
///
/// # Returns
///
/// [`true`] if libfeedback is initialized, or [`false`] otherwise.
#[doc(alias = "lfb_is_initted")]
pub fn is_initted() -> bool {
    assert_initialized_main_thread!();
    unsafe { from_glib(ffi::lfb_is_initted()) }
}

/// Sets the application id.
/// ## `app_id`
/// The application id
#[doc(alias = "lfb_set_app_id")]
pub fn set_app_id(app_id: &str) {
    assert_initialized_main_thread!();
    unsafe {
        ffi::lfb_set_app_id(app_id.to_glib_none().0);
    }
}

/// Sets the active feedback profile to #profile. It is up to the feedback
/// daemon to ignore this request. The new profile might not become active
/// immediately. You can listen to changes #LfbGdbusFeedback's ::profile
/// property to get notified when it takes effect.
/// ## `profile`
/// The profile to set
#[doc(alias = "lfb_set_feedback_profile")]
pub fn set_feedback_profile(profile: &str) {
    assert_initialized_main_thread!();
    unsafe {
        ffi::lfb_set_feedback_profile(profile.to_glib_none().0);
    }
}

/// Uninitialize the library when no longer used. Usually called
/// on program shutdown.
#[doc(alias = "lfb_uninit")]
pub fn uninit() {
    assert_initialized_main_thread!();
    unsafe {
        ffi::lfb_uninit();
    }
}