libsecret/auto/
schema.rs

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
// 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 crate::ffi;

glib::wrapper! {
    /// Represents a set of attributes that are stored with an item.
    ///
    /// These schemas are used for interoperability between various services storing
    /// the same types of items.
    ///
    /// Each schema has a name like `org.gnome.keyring.NetworkPassword`, and defines a
    /// set of attributes, and types (string, integer, boolean) for those attributes.
    ///
    /// Attributes are stored as strings in the Secret Service, and the attribute types
    /// simply define standard ways to store integer and boolean values as strings.
    /// Attributes are represented in libsecret via a [`glib::HashTable`][crate::glib::HashTable] with
    /// string keys and values. Even for values that defined as an integer or boolean in
    /// the schema, the attribute values in the [`glib::HashTable`][crate::glib::HashTable] are strings.
    /// Boolean values are stored as the strings 'true' and 'false'. Integer values are
    /// stored in decimal, with a preceding negative sign for negative integers.
    ///
    /// Schemas are handled entirely on the client side by this library. The name of the
    /// schema is automatically stored as an attribute on the item.
    ///
    /// Normally when looking up passwords only those with matching schema names are
    /// returned. If the schema @flags contain the `SECRET_SCHEMA_DONT_MATCH_NAME` flag,
    /// then lookups will not check that the schema name matches that on the item, only
    /// the schema's attributes are matched. This is useful when you are looking up
    /// items that are not stored by the libsecret library. Other libraries such as
    /// libgnome-keyring don't store the schema name.
    ///
    /// Additional schemas can be defined via the [`Schema`][crate::Schema] structure like this:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// // in a header:
    ///
    /// const SecretSchema * example_get_schema (void) G_GNUC_CONST;
    ///
    /// #define EXAMPLE_SCHEMA  example_get_schema ()
    ///
    ///
    /// // in a .c file
    ///
    /// const SecretSchema *
    /// example_get_schema (void)
    /// {
    ///     static const SecretSchema the_schema = {
    ///         "org.example.Password", SECRET_SCHEMA_NONE,
    ///         {
    ///             {  "number", SECRET_SCHEMA_ATTRIBUTE_INTEGER },
    ///             {  "string", SECRET_SCHEMA_ATTRIBUTE_STRING },
    ///             {  "even", SECRET_SCHEMA_ATTRIBUTE_BOOLEAN },
    ///             {  NULL, 0 },
    ///         }
    ///     };
    ///     return &the_schema;
    /// }
    /// ```
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct Schema(Shared<ffi::SecretSchema>);

    match fn {
        ref => |ptr| ffi::secret_schema_ref(ptr),
        unref => |ptr| ffi::secret_schema_unref(ptr),
        type_ => || ffi::secret_schema_get_type(),
    }
}