Struct SettingsSchemaSource

pub struct SettingsSchemaSource { /* private fields */ }

This is an opaque structure type. You may not access it directly.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl SettingsSchemaSource

pub fn as_ptr(&self) -> *mut GSettingsSchemaSource

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GSettingsSchemaSource) -> &Self

Borrows the underlying C value.

impl SettingsSchemaSource

pub fn from_directory( directory: impl AsRef<Path>, parent: Option<&SettingsSchemaSource>, trusted: bool, ) -> Result<SettingsSchemaSource, Error>

Attempts to create a new schema source corresponding to the contents of the given directory.

This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems.

The directory should contain a file called gschemas.compiled as produced by the [glib-compile-schemas][glib-compile-schemas] tool.

If @trusted is true then gschemas.compiled is trusted not to be corrupted. This assumption has a performance advantage, but can result in crashes or inconsistent behaviour in the case of a corrupted file. Generally, you should set @trusted to true for files installed by the system and to false for files in the home directory.

In either case, an empty file or some types of corruption in the file will result in G_FILE_ERROR_INVAL being returned.

If @parent is non-None then there are two effects.

First, if g_settings_schema_source_lookup() is called with the @recursive flag set to true and the schema can not be found in the source, the lookup will recurse to the parent.

Second, any references to other schemas specified within this source (ie: child or extends) references may be resolved from the @parent.

For this second reason, except in very unusual situations, the @parent should probably be given as the default schema source, as returned by g_settings_schema_source_get_default().

directory

the filename of a directory

parent

a #GSettingsSchemaSource, or None

trusted

true, if the directory is trusted

pub fn list_schemas(&self, recursive: bool) -> (Vec<GString>, Vec<GString>)

Lists the schemas in a given source.

If @recursive is true then include parent sources. If false then only include the schemas from one source (ie: one directory). You probably want true.

Non-relocatable schemas are those for which you can call g_settings_new(). Relocatable schemas are those for which you must use g_settings_new_with_path().

Do not call this function from normal programs. This is designed for use by database editors, commandline tools, etc.

recursive

if we should recurse

Returns

non_relocatable

the list of non-relocatable schemas, in no defined order

relocatable

the list of relocatable schemas, in no defined order

pub fn lookup(&self, schema_id: &str, recursive: bool) -> Option<SettingsSchema>

Looks up a schema with the identifier @schema_id in @self.

This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who want to introspect the content of schemas.

If the schema isn’t found directly in @self and @recursive is true then the parent sources will also be checked.

If the schema isn’t found, None is returned.

schema_id

a schema ID

recursive

true if the lookup should be recursive

Returns

a new #GSettingsSchema

pub fn default() -> Option<SettingsSchemaSource>

Gets the default system schema source.

This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who want to introspect the content of schemas.

If no schemas are installed, None will be returned.

The returned source may actually consist of multiple schema sources from different directories, depending on which directories were given in XDG_DATA_DIRS and GSETTINGS_SCHEMA_DIR. For this reason, all lookups performed against the default source should probably be done recursively.

Returns

the default schema source

Trait Implementations

impl Clone for SettingsSchemaSource

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for SettingsSchemaSource

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

Formats the value using the given formatter.

impl From<SettingsSchemaSource> for Value

fn from(s: SettingsSchemaSource) -> Self

Converts to this type from the input type.

impl HasParamSpec for SettingsSchemaSource

type ParamSpec = ParamSpecBoxed

type SetValue = SettingsSchemaSource

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, SettingsSchemaSource>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SettingsSchemaSource

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SettingsSchemaSource

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SettingsSchemaSource

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SettingsSchemaSource

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for SettingsSchemaSource

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingsSchemaSource

impl StructuralPartialEq for SettingsSchemaSource