<!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 `TypedValue` struct in crate `glib`.">
<meta name="keywords" content="rust, rustlang, rust-lang, TypedValue">
<title>glib::value::TypedValue - 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 struct">
<!--[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'>Struct TypedValue</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#deref-methods">Methods from Deref<Target=Value></a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>glib</a>::<wbr><a href='index.html'>value</a></p><script>window.sidebarCurrent = {name: 'TypedValue', ty: 'struct', 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'>Struct <a href='../index.html'>glib</a>::<wbr><a href='index.html'>value</a>::<wbr><a class="struct" href=''>TypedValue</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/value.rs.html#287' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct TypedValue<T>(_, _);</pre><div class='docblock'><p>A statically typed <a href="struct.Value.html"><code>Value</code></a>.</p>
<p>It dereferences to <code>Value</code> and can be used everywhere <code>Value</code> references are
accepted.</p>
<p>See the <a href="index.html">module documentation</a> for more details.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<'a, T: <a class="trait" href="../../glib/value/trait.FromValueOptional.html" title="trait glib::value::FromValueOptional">FromValueOptional</a><'a> + <a class="trait" href="../../glib/value/trait.SetValue.html" title="trait glib::value::SetValue">SetValue</a>> <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#289-324' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.get' class="method"><span id='get.v' class='invisible'><code>fn <a href='#method.get' class='fnname'>get</a>(&'a self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></code></span></h4>
<div class='docblock'><p>Returns the value.</p>
<p>Types that don't support a <code>None</code> value always return <code>Some</code>. See
<code>get_some</code>.</p>
</div><h4 id='method.get_some' class="method"><span id='get_some.v' class='invisible'><code>fn <a href='#method.get_some' class='fnname'>get_some</a>(&'a self) -> T <span class="where fmt-newline">where<br> T: <a class="trait" href="../../glib/value/trait.FromValue.html" title="trait glib::value::FromValue">FromValue</a><'a>, </span></code></span></h4>
<div class='docblock'><p>Returns the value.</p>
<p>This method is only available for types that don't support a <code>None</code>
value.</p>
</div><h4 id='method.set' class="method"><span id='set.v' class='invisible'><code>fn <a href='#method.set' class='fnname'>set</a><U: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../glib/value/trait.SetValueOptional.html" title="trait glib::value::SetValueOptional">SetValueOptional</a>>(&mut self, value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&U>) <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><U>, </span></code></span></h4>
<div class='docblock'><p>Sets the value.</p>
<p>This method is only available for types that support a <code>None</code> value.</p>
</div><h4 id='method.set_none' class="method"><span id='set_none.v' class='invisible'><code>fn <a href='#method.set_none' class='fnname'>set_none</a>(&mut self) <span class="where fmt-newline">where<br> T: <a class="trait" href="../../glib/value/trait.SetValueOptional.html" title="trait glib::value::SetValueOptional">SetValueOptional</a>, </span></code></span></h4>
<div class='docblock'><p>Sets the value to <code>None</code>.</p>
<p>This method is only available for types that support a <code>None</code> value.</p>
</div><h4 id='method.set_some' class="method"><span id='set_some.v' class='invisible'><code>fn <a href='#method.set_some' class='fnname'>set_some</a><U: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../glib/value/trait.SetValue.html" title="trait glib::value::SetValue">SetValue</a>>(&mut self, value: &U) <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><U>, </span></code></span></h4>
<div class='docblock'><p>Sets the value.</p>
</div></div><h2 id='deref-methods'>Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="struct" href="../../glib/value/struct.Value.html" title="struct glib::value::Value">Value</a>></h2><div class='impl-items'><h4 id='method.downcast' class="method"><span id='downcast.v' class='invisible'><code>fn <a href='#method.downcast' class='fnname'>downcast</a><'a, T: <a class="trait" href="../../glib/value/trait.FromValueOptional.html" title="trait glib::value::FromValueOptional">FromValueOptional</a><'a> + <a class="trait" href="../../glib/value/trait.SetValue.html" title="trait glib::value::SetValue">SetValue</a>>(<br> self<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><T>, Self></code></span></h4>
<div class='docblock'><p>Tries to downcast to a <code>TypedValue</code>.</p>
<p>Returns <code>Ok(TypedValue<T>)</code> if the value carries a type corresponding
to <code>T</code> and <code>Err(self)</code> otherwise.</p>
</div><h4 id='method.get-1' class="method"><span id='get.v-1' class='invisible'><code>fn <a href='#method.get-1' class='fnname'>get</a><'a, T: <a class="trait" href="../../glib/value/trait.FromValueOptional.html" title="trait glib::value::FromValueOptional">FromValueOptional</a><'a>>(&'a self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></code></span></h4>
<div class='docblock'><p>Tries to get a value of type <code>T</code>.</p>
<p>Returns <code>Some</code> if the type is correct and the value is not <code>None</code>.</p>
<p>This function doesn't distinguish between type mismatches and correctly
typed <code>None</code> values. Use <code>downcast</code> or <code>is</code> for that.</p>
</div><h4 id='method.is' class="method"><span id='is.v' class='invisible'><code>fn <a href='#method.is' class='fnname'>is</a><'a, T: <a class="trait" href="../../glib/value/trait.FromValueOptional.html" title="trait glib::value::FromValueOptional">FromValueOptional</a><'a> + <a class="trait" href="../../glib/value/trait.SetValue.html" title="trait glib::value::SetValue">SetValue</a>>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
<div class='docblock'><p>Returns <code>true</code> if the type of the value corresponds to <code>T</code>.</p>
</div><h4 id='method.type_' class="method"><span id='type_.v' class='invisible'><code>fn <a href='#method.type_' class='fnname'>type_</a>(&self) -> <a class="enum" href="../../glib/types/enum.Type.html" title="enum glib::types::Type">Type</a></code></span></h4>
<div class='docblock'><p>Returns the type of the value.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#326-330' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> Self</code></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#332-336' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#338-344' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../../glib/value/struct.Value.html" title="struct glib::value::Value">Value</a></code></span></h4>
<div class='docblock'><p>The resulting type after dereferencing</p>
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &<a class="struct" href="../../glib/value/struct.Value.html" title="struct glib::value::Value">Value</a></code></span></h4>
<div class='docblock'><p>The method called to dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#346-350' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&mut self) -> &mut <a class="struct" href="../../glib/value/struct.Value.html" title="struct glib::value::Value">Value</a></code></span></h4>
<div class='docblock'><p>The method called to mutably dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a, T: <a class="trait" href="../../glib/value/trait.FromValueOptional.html" title="trait glib::value::FromValueOptional">FromValueOptional</a><'a> + <a class="trait" href="../../glib/value/trait.SetValueOptional.html" title="trait glib::value::SetValueOptional">SetValueOptional</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a T>> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#352-356' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a T>) -> Self</code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a, T: <a class="trait" href="../../glib/value/trait.FromValueOptional.html" title="trait glib::value::FromValueOptional">FromValueOptional</a><'a> + <a class="trait" href="../../glib/value/trait.SetValue.html" title="trait glib::value::SetValue">SetValue</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><&'a T> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#358-362' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(value: &'a T) -> Self</code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#364-368' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>) -> Self</code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#370-374' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(value: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#376-380' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from-4' class="method"><span id='from.v-4' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(value: <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>) -> Self</code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>> for <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/glib/value.rs.html#382-386' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from-5' class="method"><span id='from.v-5' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(value: <a class="struct" href="../../glib/value/struct.TypedValue.html" title="struct glib::value::TypedValue">TypedValue</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> Self</code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div></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>Go to active search result</dd>
<dt>+</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>