pnmixer-rust/glib/translate/struct.Stash.html
2017-07-15 01:30:16 +02:00

139 lines
7.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `Stash` struct in crate `glib`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Stash">
<title>glib::translate::Stash - 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 Stash</p><p class='location'><a href='../index.html'>glib</a>::<wbr><a href='index.html'>translate</a></p><script>window.sidebarCurrent = {name: 'Stash', 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'>translate</a>::<wbr><a class="struct" href=''>Stash</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/glib/translate.rs.html#169' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Stash&lt;'a, P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>, T:&nbsp;?<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/translate/trait.ToGlibPtr.html" title="trait glib::translate::ToGlibPtr">ToGlibPtr</a>&lt;'a, P&gt;&gt;(pub P, pub &lt;T as <a class="trait" href="../../glib/translate/trait.ToGlibPtr.html" title="trait glib::translate::ToGlibPtr">ToGlibPtr</a>&lt;'a, P&gt;&gt;::<a class="type" href="../../glib/translate/trait.ToGlibPtr.html#associatedtype.Storage" title="type glib::translate::ToGlibPtr::Storage">Storage</a>);</pre><div class='docblock'><p>Helper type that stores temporary values used for translation.</p>
<p><code>P</code> is the foreign type pointer and the first element of the tuple.</p>
<p><code>T</code> is the Rust type that is translated.</p>
<p>The second element of the tuple is the temporary storage defined
by the implementation of <code>ToGlibPtr&lt;P&gt; for T</code></p>
<p>Say you want to pass a <code>*mut GdkWindowAttr</code> to a foreign function. The <code>Stash</code>
will own a <code>GdkWindowAttr</code> and a <code>CString</code> that <code>GdkWindowAttr::title</code> points into.</p>
<pre class="rust rust-example-rendered">
<span class="kw">impl</span> <span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">ToGlibPtr</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span>, <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">glib_ffi</span>::<span class="ident">GdkWindowAttr</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">WindowAttr</span> {
<span class="kw">type</span> <span class="ident">Storage</span> <span class="op">=</span> (<span class="ident">Box</span><span class="op">&lt;</span><span class="ident">glib_ffi</span>::<span class="ident">GdkWindowAttr</span><span class="op">&gt;</span>, <span class="ident">Stash</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span>, <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>, <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;&gt;</span>);
<span class="kw">fn</span> <span class="ident">to_glib_none</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Stash</span><span class="op">&lt;</span><span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">glib_ffi</span>::<span class="ident">GdkWindowAttr</span>, <span class="ident">WindowAttr</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">title</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">title</span>.<span class="ident">to_glib_none</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">attrs</span> <span class="op">=</span> <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">glib_ffi</span>::<span class="ident">GdkWindowAttr</span> {
<span class="ident">title</span>: <span class="ident">title</span>.<span class="number">0</span>,
<span class="comment">// ....</span>
});
<span class="ident">Stash</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="ident">attrs</span>, (<span class="ident">attrs</span>, <span class="ident">title</span>))
}
}</pre>
</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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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>