Struct gio::SettingsSchemaKey

pub struct SettingsSchemaKey(_);

SettingsSchemaKey is an opaque data structure and can only be accessed using the following functions.

Implementations

impl SettingsSchemaKey

pub fn default_value(&self) -> Variant

Gets the default value for self.

Note that this is the default value according to the schema. System administrator defaults and lockdown are not visible via this API.

Returns

the default value for the key

pub fn description(&self) -> Option<GString>

Gets the description for self.

If no description has been provided in the schema for self, returns None.

The description can be one sentence to several paragraphs in length. Paragraphs are delimited with a double newline. Descriptions can be translated and the value returned from this function is is the current locale.

This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory.

Returns

the description for self, or None

pub fn name(&self) -> GString

Gets the name of self.

Returns

the name of self.

pub fn range(&self) -> Variant

Queries the range of a key.

This function will return a glib::Variant that fully describes the range of values that are valid for self.

The type of glib::Variant returned is (sv). The string describes the type of range restriction in effect. The type and meaning of the value contained in the variant depends on the string.

If the string is 'type' then the variant contains an empty array. The element type of that empty array is the expected type of value and all values of that type are valid.

If the string is 'enum' then the variant contains an array enumerating the possible values. Each item in the array is a possible valid value and no other values are valid.

If the string is 'flags' then the variant contains an array. Each item in the array is a value that may appear zero or one times in an array to be used as the value for this key. For example, if the variant contained the array ['x', 'y'] then the valid values for the key would be [], ['x'], ['y'], ['x', 'y'] and ['y', 'x'].

Finally, if the string is 'range' then the variant contains a pair of like-typed values – the minimum and maximum permissible values for this key.

This information should not be used by normal programs. It is considered to be a hint for introspection purposes. Normal programs should already know what is permitted by their own schema. The format may change in any way in the future – but particularly, new forms may be added to the possibilities described above.

You should free the returned value with g_variant_unref() when it is no longer needed.

Returns

a glib::Variant describing the range

pub fn summary(&self) -> Option<GString>

Gets the summary for self.

If no summary has been provided in the schema for self, returns None.

The summary is a short description of the purpose of the key; usually one short sentence. Summaries can be translated and the value returned from this function is is the current locale.

This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory.

Returns

the summary for self, or None

pub fn value_type(&self) -> VariantType

Gets the glib::VariantType of self.

Returns

the type of self

pub fn range_check(&self, value: &Variant) -> bool

Checks if the given value is of the correct type and within the permitted range for self.

It is a programmer error if value is not of the correct type – you must check for this first.

value

the value to check

Returns

true if value is valid for self

Trait Implementations

impl Clone for SettingsSchemaKey

fn clone(&self) -> SettingsSchemaKey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SettingsSchemaKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SettingsSchemaKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for SettingsSchemaKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for SettingsSchemaKey

fn cmp(&self, other: &SettingsSchemaKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<SettingsSchemaKey> for SettingsSchemaKey

fn eq(&self, other: &SettingsSchemaKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SettingsSchemaKey) -> bool

This method tests for !=.

impl PartialOrd<SettingsSchemaKey> for SettingsSchemaKey

fn partial_cmp(&self, other: &SettingsSchemaKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SettingsSchemaKey

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingsSchemaKey

impl StructuralEq for SettingsSchemaKey

impl StructuralPartialEq for SettingsSchemaKey