Struct VariantDict

pub struct VariantDict { /* private fields */ }

VariantDict is a mutable key/value store where the keys are always strings and the values are Variants.

Variant dictionaries can easily be converted to/from Variants of the appropriate type. In glib terms, this is a variant of the form "a{sv}".

Panics

Note, pretty much all methods on this struct will panic if the end_unsafe() method was called on the instance.

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

Implementations

impl VariantDict

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

impl VariantDict

pub fn new(from_asv: Option<&Variant>) -> Self

Create a new VariantDict optionally populating it with the given Variant

Since Variants are immutable, this does not couple the VariantDict with the input Variant, instead the contents are copied into the VariantDict.

Panics

This function will panic if the given Variant is not of the correct type.

pub fn contains(&self, key: &str) -> bool

Check if this VariantDict contains the given key.

Look up whether or not the given key is present, returning true if it is present in self.

pub fn lookup<T: FromVariant>( &self, key: &str, ) -> Result<Option<T>, VariantTypeMismatchError>

Look up a typed value from this VariantDict.

The given key is looked up in self.

This will return None if the key is not present in the dictionary, and an error if the key is present but with the wrong type.

pub fn lookup_value( &self, key: &str, expected_type: Option<&VariantTy>, ) -> Option<Variant>

Look up and return a value from this VariantDict.

The given key is looked up in self. If expected_type is not None then it will be matched against the type of any found value.

This will return None if the key is not present in the dictionary or if it is present but the type of the value does not match a given expected_type. Otherwise, Some(value) will be returned where the value is an instance of Variant.

pub fn insert_value(&self, key: &str, value: &Variant)

Insert a variant into the dictionary.

The given key/value pair is inserted into self. If a value was previously associated with key then it is overwritten.

For convenience, you may use the insert() if you have a value which implements ToVariant.

pub fn insert(&self, key: &str, value: impl Into<Variant>)

Insert a value into the dictionary

The given key/value pair is inserted into self. If a value was previously associated with key then it is overwritten.

This is a convenience method which automatically calls to_variant() for you on the given value.

If, on the other hand, you have a Variant instance already, you should use the insert_value() method instead.

pub fn remove(&self, key: &str) -> bool

Remove the given key from the dictionary.

This removes the given key from the dictionary, releasing the reference on the associated value if one is present.

If a key/value pair was removed from the dictionary, true is returned. If key was not present then false is returned instead.

pub unsafe fn end_unsafe(&self) -> Variant

Convert this dictionary to a Variant

This method converts self into an instance of Variant but in doing so renders it very unsafe to use.

Safety

After calling this, the underlying GVariantDict is in a state where the only valid operations to perform as reference ones. As such any attempt to read/update the dictionary will fail and emit warnings of such.

You should only use this function if the extra cost of the safe function is too much for your performance critical codepaths

pub fn end(&self) -> Variant

Convert this dictionary to a Variant

This method converts self into an instance of Variant and then reinitialises itself in order to be safe for further use.

If you are certain that nothing other than disposing of references will be done after ending the instance, you can call the end_unsafe() method instead to avoid the unnecessary reinitialisation of the dictionary.

Trait Implementations

impl Clone for VariantDict

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 Default for VariantDict

fn default() -> Self

Returns the “default value” for a type.

impl From<Variant> for VariantDict

fn from(other: Variant) -> Self

Converts to this type from the input type.

impl From<VariantDict> for Value

fn from(s: VariantDict) -> Self

Converts to this type from the input type.

impl From<VariantDict> for Variant

fn from(d: VariantDict) -> Self

Consume a given VariantDict and call VariantDict::end on it.

Note: While this method consumes the VariantDict, the underlying object could still be accessed through other clones because of the reference counted clone semantics.

impl FromVariant for VariantDict

fn from_variant(variant: &Variant) -> Option<Self>

Tries to extract a value.

impl HasParamSpec for VariantDict

type ParamSpec = ParamSpecBoxed

type SetValue = VariantDict

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

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

fn param_spec_builder() -> Self::BuilderFn

impl StaticType for VariantDict

fn static_type() -> Type

Returns the type identifier of Self.

impl StaticVariantType for VariantDict

fn static_variant_type() -> Cow<'static, VariantTy>

Returns the VariantType corresponding to Self.

impl ToVariant for VariantDict

fn to_variant(&self) -> Variant

Returns a Variant clone of self.