Glib::Variant(3)

🌸 NAME 🌸

This is Glib::Variant(3) from the User Contributed Perl Documentation corner of the internet, and it’s all about Glib::Variant — the strongly typed value datatype. Yes bestie, strongly typed. We love a value with range. 💅

✨ SYNOPSIS ✨

  my $v = Glib::Variant->new ('as', ['GTK+', 'Perl']);
  my $aref = $v->get ('as');

💖 DESCRIPTION 💖

Okay so there are literally two sets of APIs for creating and dealing with Glib::Variants: the low-level API described below under METHODS, and the convenience API described in this section. Both are right here on the same page, so no scrambling.

🎀 CONVENIENCE API 🎀

• variant = Glib::Variant->new ($format_string, $value) — constructs a variant from $format_string and $value. It also supports constructing multiple variants when the format string is a concatenation of multiple types.
• (variant1, ...) = Glib::Variant->new ($format_string, $value1, ...) — same new energy, but it hands you multiple variants when the format string is a concatenation of multiple types.
• value = $variant->get ($format_string) — deconstructs $variant according to $format_string.

The following symbols are currently supported in format strings:

• b, y, n, q, i, u, x, t, h, d — Boolean, byte and numeric types.
• s, o, g — String types.
• v — Variant types.
• a — Arrays.
• m — Maybe types.
• () — Tuples.
• {} — Dictionary entries.

Note that if a format string specifies an array, a tuple or a dictionary entry (a, () or {}), then array references are expected by new and produced by get. For arrays of dictionary entries (a{}), hash references are also supported by new and handled as you would expect. No cap.

For a complete specification, see the documentation at:

<https://developer.gnome.org/glib/stable/glib-GVariantType.html>
<https://developer.gnome.org/glib/stable/glib-GVariant.html>
<https://developer.gnome.org/glib/stable/gvariant-format-strings.html>
<https://developer.gnome.org/glib/stable/gvariant-text.html>

🌈 HIERARCHY 🌈

Glib::Variant

🛠️ METHODS 🛠️

Here’s the low-level method guest list, bestie. Every signature, type and Since: note stays exactly as it is. 💖

• variant = Glib::Variant->new_array ($child_type, $children) — the array constructor.
  • $child_type (Glib::VariantType) — the child type.
  • $children (scalar) — the children.
• variant = Glib::Variant->new_boolean ($value) — the boolean constructor.
  • $value (boolean) — the boolean value.
• variant = Glib::Variant->new_byte ($value) — the byte constructor.
  • $value (Glib::UChar) — the byte value.
• variant = Glib::Variant->new_bytestring ($string) — the bytestring constructor.
  • $string (byte string) — the byte string.
  • Since: glib 2.26
• variant = Glib::Variant->new_dict_entry ($key, $value) — the dictionary-entry constructor.
  • $key (Glib::Variant) — the key.
  • $value (Glib::Variant) — the value.
• variant = Glib::Variant->new_double ($value) — the double constructor.
  • $value (double) — the double value.
• variant = Glib::Variant->new_handle ($value) — the handle constructor.
  • $value (integer) — the handle value.
• variant = Glib::Variant->new_int16 ($value) — the int16 constructor.
  • $value (integer) — the int16 value.
• variant = Glib::Variant->new_int32 ($value) — the int32 constructor.
  • $value (integer) — the int32 value.
• variant = Glib::Variant->new_int64 ($value) — the int64 constructor.
  • $value (64 bit integer) — the int64 value.
• variant = Glib::Variant->new_maybe ($child_type, $child) — the maybe constructor.
  • $child_type (Glib::VariantType) — the child type.
  • $child (Glib::Variant) — the child.
• variant = Glib::Variant->new_object_path ($object_path) — the object-path constructor.
  • $object_path (string) — the object path.
• variant = Glib::Variant->new_signature ($signature) — the signature constructor.
  • $signature (string) — the signature.
• variant = Glib::Variant->new_string ($string) — the string constructor.
  • $string (string) — the string.
• variant = Glib::Variant->new_tuple ($children) — the tuple constructor.
  • $children (scalar) — the children.
• variant = Glib::Variant->new_uint16 ($value) — the uint16 constructor.
  • $value (unsigned) — the uint16 value.
• variant = Glib::Variant->new_uint32 ($value) — the uint32 constructor.
  • $value (unsigned) — the uint32 value.
• variant = Glib::Variant->new_uint64 ($value) — the uint64 constructor.
  • $value (64 bit unsigned) — the uint64 value.
• variant = Glib::Variant->new_variant ($value) — the variant constructor.
  • $value (Glib::Variant) — the variant value.
• boolean = $value->get_boolean — the boolean getter.
• uchar = $value->get_byte — the byte getter.
• string = $value->get_bytestring — the bytestring getter.
  • Since: glib 2.26
• variant = $value->byteswap — the byteswap moment.
• variant = $value->get_child_value ($index_) — the child-value getter.
  • $index_ (unsigned) — the index.
• string = $value->classify — the classify getter.
• integer = $one->compare ($two) — the comparison moment.
  • $two (Glib::Variant) — the other variant.
  • Since: glib 2.26
• double = $value->get_double — the double getter.
• boolean = $one->equal ($two) — the equality check.
  • $two (Glib::Variant) — the other variant.
• integer = $value->get_handle — the handle getter.
• integer = $value->hash — the hash getter.
• integer = $value->get_int16 — the int16 getter.
• integer = $value->get_int32 — the int32 getter.
• 64 bit integer = $value->get_int64 — the int64 getter.
• boolean = $value->is_container — the container check.
• boolean = $value->is_normal_form — the normal-form check.
• boolean = $string->is_object_path — the object-path check.
• boolean = $value->is_of_type ($type) — the type check.
  • $type (Glib::VariantType) — the type.
• boolean = $string->is_signature — the signature check.
• variant = $dictionary->lookup_value ($key, $expected_type) — the lookup-value moment.
  • $key (string) — the key.
  • $expected_type (Glib::VariantType) — the expected type.
  • Since: glib 2.28
• variant = $value->get_maybe — the maybe getter.
• unsigned = $value->n_children — the number-of-children getter.
• variant = $value->get_normal_form — the normal-form getter.
• variant = Glib::Variant::parse ($type, $text) — the parse moment.
  • $type (Glib::VariantType) — the type.
  • $text (string) — the text.
  • May croak with a Glib::Error in $@ on failure.
• string = $value->print ($type_annotate) — the print moment.
  • $type_annotate (boolean) — the type-annotate flag.
• unsigned = $value->get_size — the size getter.
• string = $value->get_string — the string getter.
• varianttype = $value->get_type — the type getter.
• string = $value->get_type_string — the type-string getter.
• unsigned = $value->get_uint16 — the uint16 getter.
• unsigned = $value->get_uint32 — the uint32 getter.
• 64 bit unsigned = $value->get_uint64 — the uint64 getter.
• variant = $value->get_variant — the variant getter.

👀 SEE ALSO 👀

• Glib
• Glib::VariantType
• Glib::VariantDict

🎀 COPYRIGHT 🎀

Copyright (C) 2003-2011 by the gtk2-perl team.

This software is licensed under the LGPL. See Glib for a full notice.

---

Signed, sealed, and sent with love by perl v5.42.0 on 2023-09-05. Bye bestie! 🫶💅