Variant

Object Hierarchy:

Description:

[ Compact ]
[ Version ( since = "2.24" ) ]
[ CCode ( get_value_function = "g_value_get_variant" , marshaller_type_name = "VARIANT" , param_spec_function = "g_param_spec_variant" , ref_function = "g_variant_ref" , ref_sink_function = "g_variant_ref_sink" , set_value_function = "g_value_set_variant" , take_value_function = "g_value_take_variant" , type_id = "G_TYPE_VARIANT" , type_signature = "v" , unref_function = "g_variant_unref" ) ]
public class Variant

`GVariant` is a variant datatype; it can contain one or more values along with information about the type of the values.

A `GVariant` may contain simple types, like an integer, or a boolean value; or complex types, like an array of two strings, or a dictionary of key value pairs. A `GVariant` is also immutable: once it’s been created neither its type nor its content can be modified further.

`GVariant` is useful whenever data needs to be serialized, for example when sending method parameters in D-Bus, or when saving settings using [ `GSettings`](../gio/class.Settings.html).

When creating a new `GVariant`, you pass the data you want to store in it along with a string representing the type of data you wish to pass to it.

For instance, if you want to create a `GVariant` holding an integer value you can use:

```c GVariant *v = g_variant_new ("u", 40); ```

The string `u` in the first argument tells `GVariant` that the data passed to the constructor (`40`) is going to be an unsigned integer.

More advanced examples of `GVariant` in use can be found in documentation for [`GVariant` format strings](gvariant-format-strings.html#pointers ).

The range of possible values is determined by the type.

The type system used by `GVariant` is [type@GLib.VariantType].

`GVariant` instances always have a type and a value (which are given at construction time). The type and value of a `GVariant` instance can never change other than by the `GVariant` itself being destroyed. A `GVariant` cannot contain a pointer.

`GVariant` is reference counted using [method@GLib.Variant.ref] and [method@GLib.Variant.unref]. `GVariant` also has floating reference counts — see [method@GLib.Variant.ref_sink].

`GVariant` is completely threadsafe. A `GVariant` instance can be concurrently accessed in any way from any number of threads without problems.

`GVariant` is heavily optimised for dealing with data in serialized form. It works particularly well with data located in memory-mapped files. It can perform nearly all deserialization operations in a small constant time, usually touching only a single memory page. Serialized `GVariant` data can also be sent over the network.

`GVariant` is largely compatible with D-Bus. Almost all types of `GVariant` instances can be sent over D-Bus. See [type@GLib.VariantType] for exceptions. (However, `GVariant`’s serialization format is not the same as the serialization format of a D-Bus message body: use [GDBusMessage ](../gio/class.DBusMessage.html), in the GIO library, for those.)

For space-efficiency, the `GVariant` serialization format does not automatically include the variant’s length, type or endianness, which must either be implied from context (such as knowledge that a particular file format always contains a little-endian `G_VARIANT_TYPE_VARIANT` which occupies the whole length of the file) or supplied out-of-band (for instance, a length, type and/or endianness indicator could be placed at the beginning of a file, network message or network stream).

A `GVariant`’s size is limited mainly by any lower level operating system constraints, such as the number of bits in `gsize`. For example, it is reasonable to have a 2GB file mapped into memory with [struct@GLib.MappedFile], and call [ctor@GLib.Variant.new_from_data] on it.

For convenience to C programmers, `GVariant` features powerful varargs-based value construction and destruction. This feature is designed to be embedded in other libraries.

There is a Python-inspired text language for describing `GVariant` values. `GVariant` includes a printer for this language and a parser with type inferencing.

Memory Use

`GVariant` tries to be quite efficient with respect to memory use. This section gives a rough idea of how much memory is used by the current implementation. The information here is subject to change in the future.

The memory allocated by `GVariant` can be grouped into 4 broad purposes: memory for serialized data, memory for the type information cache, buffer management memory and memory for the `GVariant` structure itself.

Serialized Data Memory

This is the memory that is used for storing `GVariant` data in serialized form. This is what would be sent over the network or what would end up on disk, not counting any indicator of the endianness, or of the length or type of the top-level variant.

The amount of memory required to store a boolean is 1 byte. 16, 32 and 64 bit integers and double precision floating point numbers use their ‘natural’ size. Strings (including object path and signature strings) are stored with a nul terminator, and as such use the length of the string plus 1 byte.

‘Maybe’ types use no space at all to represent the null value and use the same amount of space (sometimes plus one byte) as the equivalent non-maybe-typed value to represent the non-null case.

Arrays use the amount of space required to store each of their members, concatenated. Additionally, if the items stored in an array are not of a fixed-size (ie: strings, other arrays, etc) then an additional framing offset is stored for each item. The size of this offset is either 1, 2 or 4 bytes depending on the overall size of the container. Additionally, extra padding bytes are added as required for alignment of child values.

Tuples (including dictionary entries) use the amount of space required to store each of their members, concatenated, plus one framing offset ( as per arrays) for each non-fixed-sized item in the tuple, except for the last one. Additionally, extra padding bytes are added as required for alignment of child values.

Variants use the same amount of space as the item inside of the variant, plus 1 byte, plus the length of the type string for the item inside the variant.

As an example, consider a dictionary mapping strings to variants. In the case that the dictionary is empty, 0 bytes are required for the serialization.

If we add an item ‘width’ that maps to the int32 value of 500 then we will use 4 bytes to store the int32 (so 6 for the variant containing it) and 6 bytes for the string. The variant must be aligned to 8 after the 6 bytes of the string, so that’s 2 extra bytes. 6 (string) + 2 ( padding) + 6 (variant) is 14 bytes used for the dictionary entry. An additional 1 byte is added to the array as a framing offset making a total of 15 bytes.

If we add another entry, ‘title’ that maps to a nullable string that happens to have a value of null, then we use 0 bytes for the null value (and 3 bytes for the variant to contain it along with its type string) plus 6 bytes for the string. Again, we need 2 padding bytes. That makes a total of 6 + 2 + 3 = 11 bytes.

We now require extra padding between the two items in the array. After the 14 bytes of the first item, that’s 2 bytes required. We now require 2 framing offsets for an extra two bytes. 14 + 2 + 11 + 2 = 29 bytes to encode the entire two-item dictionary.

Type Information Cache

For each `GVariant` type that currently exists in the program a type information structure is kept in the type information cache. The type information structure is required for rapid deserialization.

Continuing with the above example, if a `GVariant` exists with the type `a{sv}` then a type information struct will exist for `a{sv}`, `{sv}`, `s`, and `v`. Multiple uses of the same type will share the same type information. Additionally, all single-digit types are stored in read-only static memory and do not contribute to the writable memory footprint of a program using `GVariant`.

Aside from the type information structures stored in read-only memory, there are two forms of type information. One is used for container types where there is a single element type: arrays and maybe types. The other is used for container types where there are multiple element types: tuples and dictionary entries.

Array type info structures are `6 * sizeof (void *)`, plus the memory required to store the type string itself. This means that on 32-bit systems, the cache entry for `a{sv}` would require 30 bytes of memory (plus allocation overhead).

Tuple type info structures are `6 * sizeof (void *)`, plus `4 * sizeof (void *)` for each item in the tuple, plus the memory required to store the type string itself. A 2-item tuple, for example, would have a type information structure that consumed writable memory in the size of `14 * sizeof (void *)` (plus type string) This means that on 32-bit systems, the cache entry for `{sv}` would require 61 bytes of memory (plus allocation overhead).

This means that in total, for our `a{sv}` example, 91 bytes of type information would be allocated.

The type information cache, additionally, uses a [struct@GLib.HashTable] to store and look up the cached items and stores a pointer to this hash table in static storage. The hash table is freed when there are zero items in the type cache.

Although these sizes may seem large it is important to remember that a program will probably only have a very small number of different types of values in it and that only one type information structure is required for many different values of the same type.

Buffer Management Memory

`GVariant` uses an internal buffer management structure to deal with the various different possible sources of serialized data that it uses. The buffer is responsible for ensuring that the correct call is made when the data is no longer in use by `GVariant`. This may involve a [ func@GLib.free] or even [method@GLib.MappedFile.unref].

One buffer management structure is used for each chunk of serialized data. The size of the buffer management structure is `4 * (void *)`. On 32-bit systems, that’s 16 bytes.

GVariant structure

The size of a `GVariant` structure is `6 * (void *)`. On 32-bit systems, that’s 24 bytes.

`GVariant` structures only exist if they are explicitly created with API calls. For example, if a `GVariant` is constructed out of serialized data for the example given above (with the dictionary) then although there are 9 individual values that comprise the entire dictionary (two keys, two values, two variants containing the values, two dictionary entries, plus the dictionary itself), only 1 `GVariant` instance exists — the one referring to the dictionary.

If calls are made to start accessing the other values then `GVariant` instances will exist for those values only for as long as they are in use (ie: until you call [method@GLib.Variant.unref]). The type information is shared. The serialized data and the buffer management structure for that serialized data is shared by the child.

Summary

To put the entire example together, for our dictionary mapping strings to variants (with two entries, as given above), we are using 91 bytes of memory for type information, 29 bytes of memory for the serialized data, 16 bytes for buffer management and 24 bytes for the `GVariant` instance, or a total of 160 bytes, plus allocation overhead. If we were to use [method@GLib.Variant.get_child_value] to access the two dictionary entries, we would use an additional 48 bytes. If we were to have other dictionaries of the same type, we would use more memory for the serialized data and buffer management for those dictionaries, but the type information would be shared.

Example: Create a new variant with a type string:

public static int main (string[] args) {
	Variant var1 = new Variant ("(ssi)", "aa", "bb", 10);
	string? val1 = null;
	string? val2 = null;
	int val3 = -1;

	VariantIter iter = var1.iterator ();
	iter.next ("s", &val1);
	iter.next ("s", &val2);
	iter.next ("i", &val3);

	// Output: ``aa, bb, 10``
	print ("%s, %s, %d\n", val1, val2, val3);

	return 0;
}

valac --pkg glib-2.0 GLib.Variant.Variant.vala

Namespace: GLib

Package: glib-2.0

Content:

Enums:

Class - The range of possible top-level types of Variant instances.

Static methods:

public static bool is_object_path (string object_path)
Determines if a given string is a valid D-Bus object path.
public static bool is_signature (string signature)
Determines if a given string is a valid D-Bus type signature.
public static Variant new_fixed_array<T> (VariantType? element_type, T[] elements, size_t element_size)
Constructs a new array Variant instance, where the elements are of element_type type.
public static Variant new_from_data<T> (VariantType type, uchar[] data, bool trusted, owned T owner = null)
Creates a new Variant instance from serialized data.
public static Variant parse (VariantType? type, string text, char* limit = null, char** endptr = null) throws VariantParseError
Parses a Variant from a text representation.
public static void parse_error_print_context (VariantParseError error, string source_str)
Pretty-prints a message showing the context of a Variant parse error within the string for which parsing was attempted.

Creation methods:

public Variant (string format, ...)
Creates a new Variant instance.
public Variant.array (VariantType? child_type, Variant[] children)
Creates a new Variant array from children.
public Variant.boolean (bool value)
Creates a new boolean Variant instance -- either true or false.
public Variant.byte (uint8 value)
Creates a new byte Variant instance.
public Variant.bytestring (string value)
Creates an array-of-bytes Variant with the contents of string.
public Variant.bytestring_array (string[] value)
Constructs an array of bytestring Variant from the given array of strings.
public Variant.dict_entry (Variant key, Variant value)
Creates a new dictionary entry Variant.
public Variant.double (double value)
Creates a new double Variant instance.
public Variant.from_bytes (VariantType type, Bytes bytes, bool trusted)
Constructs a new serialized-mode Variant instance.
public Variant.handle (int32 value)
Creates a new handle Variant instance.
public Variant.int16 (int16 value)
Creates a new int16 Variant instance.
public Variant.int32 (int32 value)
Creates a new int32 Variant instance.
public Variant.int64 (int64 value)
Creates a new int64 Variant instance.
public Variant.maybe (VariantType? child_type, Variant? child)
Depending on if child is null , either wraps child inside of a maybe container or creates a Nothing instance for the given type.
public Variant.object_path (string object_path)
Creates a D-Bus object path Variant with the contents of object_path.
public Variant.objv (string[] value)
Constructs an array of object paths Variant from the given array of strings.
public Variant.parsed (string format_string, ...)
Parses format and returns the result.
public Variant.printf (string format_string, ...)
Creates a string-type GVariant using printf formatting.
public Variant.signature (string signature)
Creates a D-Bus type signature Variant with the contents of string.
public Variant.string (string value)
Creates a string Variant with the contents of string.
public Variant.strv (string[] value)
Constructs an array of strings Variant from the given array of strings.
public Variant.take_string (owned string str)
Creates a string Variant with the contents of string.
public Variant.tuple (Variant[] children)
Creates a new tuple Variant out of the items in children.
public Variant.uint16 (uint16 value)
Creates a new uint16 Variant instance.
public Variant.uint32 (uint32 value)
Creates a new uint32 Variant instance.
public Variant.uint64 (uint64 value)
Creates a new uint64 Variant instance.
public Variant.va (string format, char** end_ptr, va_list* app)
This function is intended to be used by libraries based on Variant that want to provide Variant -like functionality to their users.
public Variant.variant (Variant value)
Boxes value.

Methods:

public void @get (string format, ...)
Deconstructs a Variant instance.
public Variant byteswap ()
Performs a byteswapping operation on the contents of this.
public bool check_format_string (string format_string, bool copy_only)
Checks if calling @get with format_string on this would be valid from a type-compatibility standpoint.
public Class classify ()
Classifies this according to its top-level type.
public int compare (Variant other)
Compares this and two.
public string dup_bytestring (out size_t length)
Similar to get_bytestring except that instead of returning a constant string, the string is duplicated.
public string[] dup_bytestring_array ()
Gets the contents of an array of array of bytes Variant .
public string[] dup_objv ()
Gets the contents of an array of object paths Variant .
public string dup_string (out size_t length = null)
Similar to get_string except that instead of returning a constant string, the string is duplicated.
public string[] dup_strv ()
Gets the contents of an array of strings Variant.
public bool equal (Variant other)
Checks if this and two have the same type and value.
public bool get_boolean ()
Returns the boolean value of this.
public uint8 get_byte ()
Returns the byte value of this.
public unowned string get_bytestring ()
Returns the string value of a Variant instance with an array-of-bytes type.
public (unowned string)[] get_bytestring_array ()
Gets the contents of an array of array of bytes Variant .
public void get_child (size_t index, string format_string, ...)
Reads a child item out of a container Variant instance and deconstructs it according to format_string.
public Variant get_child_value (size_t index)
Reads a child item out of a container Variant instance.
public void* get_data ()
Returns a pointer to the serialized form of a Variant instance.
public Bytes get_data_as_bytes ()
Returns a pointer to the serialized form of a Variant instance.
public double get_double ()
Returns the double precision floating point value of this.
public int32 get_handle ()
Returns the 32-bit signed integer value of this .
public int16 get_int16 ()
Returns the 16-bit signed integer value of this .
public int32 get_int32 ()
Returns the 32-bit signed integer value of this .
public int64 get_int64 ()
Returns the 64-bit signed integer value of this .
public Variant? get_maybe ()
Given a maybe-typed Variant instance, extract its value.
public Variant get_normal_form ()
Gets a Variant instance that has the same value as this and is trusted to be in normal form.
public (unowned string)[] get_objv ()
Gets the contents of an array of object paths Variant .
public size_t get_size ()
Determines the number of bytes that would be required to store this with store.
public unowned string get_string (out size_t length = null)
Returns the string value of a Variant instance with a string type.
public (unowned string)[] get_strv ()
Gets the contents of an array of strings Variant.
public unowned VariantType get_type ()
Determines the type of this.
public unowned string get_type_string ()
Returns the type string of this.
public uint16 get_uint16 ()
Returns the 16-bit unsigned integer value of this .
public uint32 get_uint32 ()
Returns the 32-bit unsigned integer value of this .
public uint64 get_uint64 ()
Returns the 64-bit unsigned integer value of this .
public void get_va (string format, char** end_ptr, va_list* app)
This function is intended to be used by libraries based on Variant that want to provide @get-like functionality to their users.
public Variant get_variant ()
Unboxes this.
public uint hash ()
Generates a hash value for a Variant instance.
public bool is_container ()
Checks if this is a container.
public bool is_floating ()
Checks whether this has a floating reference count.
public bool is_normal_form ()
Checks if this is in normal form.
public bool is_of_type (VariantType type)
Checks if a value has a type matching the provided type.
public VariantIter iterator ()
public bool lookup (string key, string format_string, ...)
Looks up a value in a dictionary Variant.
public Variant? lookup_value (string key, VariantType? expected_type)
Looks up a value in a dictionary Variant.
public size_t n_children ()
Determines the number of children in a container Variant instance.
public string print (bool type_annotate)
Pretty-prints this in the format understood by parse.
public StringBuilder print_string (StringBuilder? builder, bool type_annotate)
Behaves as print , but operates on a StringBuilder.
public void store (void* data)
Stores the serialized form of this at data.