<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `variant` mod in crate `glib`.">
<meta name="keywords" content="rust, rustlang, rust-lang, variant">
<title>glib::variant - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Module variant</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>glib</a></p><script>window.sidebarCurrent = {name: 'variant', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>glib</a>::<wbr><a class="mod" href=''>variant</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../../src/glib/variant.rs.html#5-357' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p><code>Variant</code> binding and helper traits.</p>
<p><a href="struct.Variant.html"><code>Variant</code></a> is an immutable dynamically-typed generic
container. Its type and value are defined at construction and never change.</p>
<p><code>Variant</code> types are described by <a href="../struct.VariantType.html"><code>VariantType</code></a>
"type strings".</p>
<p>Although <code>GVariant</code> supports arbitrarily complex types, this binding is
currently limited to the basic ones: <code>bool</code>, <code>u8</code>, <code>i16</code>, <code>u16</code>, <code>i32</code>,
<code>u32</code>, <code>i64</code>, <code>u64</code>, <code>f64</code> and <code>&str</code>/<code>String</code>.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">glib</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>; <span class="comment">// or `use gtk::prelude::*;`</span>
<span class="kw">use</span> <span class="ident">glib</span>::<span class="ident">Variant</span>;
<span class="comment">// Using the `ToVariant` trait.</span>
<span class="kw">let</span> <span class="ident">num</span> <span class="op">=</span> <span class="number">10</span>.<span class="ident">to_variant</span>();
<span class="comment">// `is` tests the type of the value.</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">num</span>.<span class="ident">is</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>());
<span class="comment">// `get` tries to extract the value.</span>
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">num</span>.<span class="ident">get</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>(), <span class="prelude-val">Some</span>(<span class="number">10</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">num</span>.<span class="ident">get</span>::<span class="op"><</span><span class="ident">u32</span><span class="op">></span>(), <span class="prelude-val">None</span>);
<span class="comment">// `Variant` implements `From`</span>
<span class="kw">let</span> <span class="ident">hello</span> <span class="op">=</span> <span class="ident">Variant</span>::<span class="ident">from</span>(<span class="string">"Hello!"</span>);
<span class="comment">// `get_str` tries to borrow a string slice.</span>
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">hello</span>.<span class="ident">get_str</span>(), <span class="prelude-val">Some</span>(<span class="string">"Hello!"</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">num</span>.<span class="ident">get_str</span>(), <span class="prelude-val">None</span>);</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Variant.html"
title='struct glib::variant::Variant'>Variant</a></td>
<td class='docblock-short'>
<p>A generic immutable value capable of carrying various types.</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.FromVariant.html"
title='trait glib::variant::FromVariant'>FromVariant</a></td>
<td class='docblock-short'>
<p>Extracts a value.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.StaticVariantType.html"
title='trait glib::variant::StaticVariantType'>StaticVariantType</a></td>
<td class='docblock-short'>
<p>Returns <code>VariantType</code> of <code>Self</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.ToVariant.html"
title='trait glib::variant::ToVariant'>ToVariant</a></td>
<td class='docblock-short'>
<p>Converts to <code>Variant</code>.</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>↑</dt>
<dd>Move up in search results</dd>
<dt>↓</dt>
<dd>Move down in search results</dd>
<dt>↹</dt>
<dd>Switch tab</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt style="width:31px;">+ / -</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "glib";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>