GI.GLib.Structs.VariantDict

GVariant dictionaries.

It can be used for doing a sequence of dictionary lookups in an efficient way on an existing #GVariant dictionary or it can be used to construct new dictionaries with a hashtable-like interface. It can also be used for taking existing dictionaries and modifying them in order to create new ones.

#GVariantDict can only be used with %G_VARIANT_TYPE_VARDICT dictionaries.

It is possible to use #GVariantDict allocated on the stack or on the heap. When using a stack-allocated #GVariantDict, you begin with a call to g_variant_dict_init() and free the resources with a call to g_variant_dict_clear().

Heap-allocated #GVariantDict follows normal refcounting rules: you allocate it with g_variant_dict_new() and use g_variant_dict_ref() and g_variant_dict_unref().

g_variant_dict_end() is used to convert the #GVariantDict back into a dictionary-type #GVariant. When used with stack-allocated instances, this also implicitly frees all associated memory, but for heap-allocated instances, you must still call g_variant_dict_unref() afterwards.

You will typically want to use a heap-allocated #GVariantDict when you expose it as part of an API. For most other uses, the stack-allocated form will be more convenient.

Consider the following two examples that do the same thing in each style: take an existing dictionary and look up the "count" uint32 key, adding 1 to it if it is found, or returning an error if the key is not found. Each returns the new dictionary as a floating #GVariant.

## Using a stack-allocated GVariantDict

|[language="C" -- GVariant * add_to_count (GVariant *orig, GError **error) { GVariantDict dict; guint32 count;

g_variant_dict_init (&dict, orig); if (!g_variant_dict_lookup (&dict, "count", "u", &count)) { g_set_error (...); g_variant_dict_clear (&dict); return NULL; }

g_variant_dict_insert (&dict, "count", "u", count + 1);

return g_variant_dict_end (&dict); } ]|

## Using heap-allocated GVariantDict

|[language="C" -- GVariant * add_to_count (GVariant *orig, GError **error) { GVariantDict *dict; GVariant *result; guint32 count;

dict = g_variant_dict_new (orig);

if (g_variant_dict_lookup (dict, "count", "u", &count)) { g_variant_dict_insert (dict, "count", "u", count + 1); result = g_variant_dict_end (dict); } else { g_set_error (...); result = NULL; }

g_variant_dict_unref (dict);

return result; } ]|

Exported types

newtype VariantDict

Constructors

VariantDict (ForeignPtr VariantDict)

Instances

BoxedObject VariantDict

Methods

boxedType :: VariantDict -> IO GType

(~) AttrOpTag tag AttrSet => Constructible VariantDict tag

Methods

new :: MonadIO m => (ForeignPtr VariantDict -> VariantDict) -> [AttrOp VariantDict tag] -> m VariantDict

((~) * info (ResolveVariantDictMethod t VariantDict), MethodInfo * info VariantDict p) => IsLabel t (VariantDict -> p)

Methods

fromLabel :: Proxy# Symbol t -> VariantDict -> p

((~) * info (ResolveVariantDictMethod t VariantDict), MethodInfo * info VariantDict p) => IsLabelProxy t (VariantDict -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> VariantDict -> p

((~) * signature (m ()), MonadIO m) => MethodInfo * VariantDictUnrefMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictUnrefMethodInfo VariantDict -> signature -> s

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * VariantDictRemoveMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictRemoveMethodInfo VariantDict -> signature -> s

((~) * signature (m VariantDict), MonadIO m) => MethodInfo * VariantDictRefMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictRefMethodInfo VariantDict -> signature -> s

((~) * signature (Text -> Maybe VariantType -> m GVariant), MonadIO m) => MethodInfo * VariantDictLookupValueMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictLookupValueMethodInfo VariantDict -> signature -> s

((~) * signature (Text -> GVariant -> m ()), MonadIO m) => MethodInfo * VariantDictInsertValueMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictInsertValueMethodInfo VariantDict -> signature -> s

((~) * signature (m GVariant), MonadIO m) => MethodInfo * VariantDictEndMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictEndMethodInfo VariantDict -> signature -> s

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * VariantDictContainsMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictContainsMethodInfo VariantDict -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * VariantDictClearMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictClearMethodInfo VariantDict -> signature -> s

type AttributeList VariantDict

type AttributeList VariantDict

newZeroVariantDict :: MonadIO m => m VariantDict

Construct a VariantDict struct initialized to zero.

noVariantDict :: Maybe VariantDict

Methods

variantDictClear

data VariantDictClearMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * VariantDictClearMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictClearMethodInfo VariantDict -> signature -> s

variantDictClear :: MonadIO m => VariantDict -> m ()

variantDictContains

data VariantDictContainsMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * VariantDictContainsMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictContainsMethodInfo VariantDict -> signature -> s

variantDictContains :: MonadIO m => VariantDict -> Text -> m Bool

variantDictEnd

data VariantDictEndMethodInfo

Instances

((~) * signature (m GVariant), MonadIO m) => MethodInfo * VariantDictEndMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictEndMethodInfo VariantDict -> signature -> s

variantDictEnd :: MonadIO m => VariantDict -> m GVariant

variantDictInsertValue

data VariantDictInsertValueMethodInfo

Instances

((~) * signature (Text -> GVariant -> m ()), MonadIO m) => MethodInfo * VariantDictInsertValueMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictInsertValueMethodInfo VariantDict -> signature -> s

variantDictInsertValue :: MonadIO m => VariantDict -> Text -> GVariant -> m ()

variantDictLookupValue

data VariantDictLookupValueMethodInfo

Instances

((~) * signature (Text -> Maybe VariantType -> m GVariant), MonadIO m) => MethodInfo * VariantDictLookupValueMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictLookupValueMethodInfo VariantDict -> signature -> s

variantDictLookupValue :: MonadIO m => VariantDict -> Text -> Maybe VariantType -> m GVariant

variantDictNew

variantDictNew :: MonadIO m => Maybe GVariant -> m VariantDict

variantDictRef

data VariantDictRefMethodInfo

Instances

((~) * signature (m VariantDict), MonadIO m) => MethodInfo * VariantDictRefMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictRefMethodInfo VariantDict -> signature -> s

variantDictRef :: MonadIO m => VariantDict -> m VariantDict

variantDictRemove

data VariantDictRemoveMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * VariantDictRemoveMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictRemoveMethodInfo VariantDict -> signature -> s

variantDictRemove :: MonadIO m => VariantDict -> Text -> m Bool

variantDictUnref

data VariantDictUnrefMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * VariantDictUnrefMethodInfo VariantDict signature

Methods

overloadedMethod :: MethodProxy VariantDictUnrefMethodInfo VariantDict -> signature -> s

variantDictUnref :: MonadIO m => VariantDict -> m ()