361 lines
20 KiB
HTML
361 lines
20 KiB
HTML
<!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 `translate` mod in crate `glib`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, translate">
|
||
|
||
<title>glib::translate - 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 translate</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>glib</a></p><script>window.sidebarCurrent = {name: 'translate', 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=''>translate</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/translate.rs.html#5-1412' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Translation between GLib/GLib-based FFI types and their Rust counterparts.</p>
|
||
|
||
<p>This module allows library bindings authors to decouple type translation
|
||
logic and use unified idioms at FFI boundaries. It also implements
|
||
translation of GLib core data types.</p>
|
||
|
||
<p><code>FromGlib</code>, <code>from_glib</code> and <code>ToGlib</code> translate simple types like <code>bool</code>.</p>
|
||
|
||
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_accept_focus</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">accept_focus</span>: <span class="ident">bool</span>) {
|
||
<span class="kw">unsafe</span> { <span class="ident">glib_ffi</span>::<span class="ident">gdk_window_set_accept_focus</span>(<span class="self">self</span>.<span class="ident">pointer</span>, <span class="ident">accept_focus</span>.<span class="ident">to_glib</span>()) }
|
||
}
|
||
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_accept_focus</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span> {
|
||
<span class="kw">unsafe</span> { <span class="ident">from_glib</span>(<span class="ident">glib_ffi</span>::<span class="ident">gdk_window_get_accept_focus</span>(<span class="self">self</span>.<span class="ident">pointer</span>)) }
|
||
}</pre>
|
||
|
||
<p><code>ToGlibPtr</code>, <code>FromGlibPtrNone</code>, <code>FromGlibPtrFull</code> and <code>FromGlibPtrBorrow</code> work on <code>gpointer</code>s
|
||
and support different modes of ownership transfer.</p>
|
||
|
||
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
||
<span class="kw">fn</span> <span class="ident">get_title</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
|
||
<span class="kw">unsafe</span> {
|
||
<span class="kw">let</span> <span class="ident">title</span> <span class="op">=</span> <span class="ident">glib_ffi</span>::<span class="ident">gtk_window_get_title</span>(<span class="self">self</span>.<span class="ident">pointer</span>);
|
||
<span class="ident">from_glib_none</span>(<span class="ident">title</span>)
|
||
}
|
||
}</pre>
|
||
|
||
<p>Letting the foreign library borrow pointers from the Rust side often
|
||
requires having a temporary variable of an intermediate type (e.g. <code>CString</code>).
|
||
A <code>Stash</code> contains the temporary storage and a pointer into it that
|
||
is valid for the lifetime of the <code>Stash</code>. As the lifetime of the <code>Stash</code> returned
|
||
from <code>to_glib_none</code> is at least the enclosing statement, you can avoid explicitly
|
||
binding the stash in most cases and just take the pointer out of it:</p>
|
||
|
||
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_icon_name</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">name</span>: <span class="kw-2">&</span><span class="ident">str</span>) {
|
||
<span class="kw">unsafe</span> {
|
||
<span class="ident">glib_ffi</span>::<span class="ident">gdk_window_set_icon_name</span>(<span class="self">self</span>.<span class="ident">pointer</span>, <span class="ident">name</span>.<span class="ident">to_glib_none</span>().<span class="number">0</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.HashTable.html"
|
||
title='struct glib::translate::HashTable'>HashTable</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.List.html"
|
||
title='struct glib::translate::List'>List</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.SList.html"
|
||
title='struct glib::translate::SList'>SList</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Stash.html"
|
||
title='struct glib::translate::Stash'>Stash</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper type that stores temporary values used for translation.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.StashMut.html"
|
||
title='struct glib::translate::StashMut'>StashMut</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</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.FromGlib.html"
|
||
title='trait glib::translate::FromGlib'>FromGlib</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate a simple type.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.FromGlibContainer.html"
|
||
title='trait glib::translate::FromGlibContainer'>FromGlibContainer</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate from a container.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.FromGlibContainerAsVec.html"
|
||
title='trait glib::translate::FromGlibContainerAsVec'>FromGlibContainerAsVec</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.FromGlibPtrArrayContainerAsVec.html"
|
||
title='trait glib::translate::FromGlibPtrArrayContainerAsVec'>FromGlibPtrArrayContainerAsVec</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.FromGlibPtrBorrow.html"
|
||
title='trait glib::translate::FromGlibPtrBorrow'>FromGlibPtrBorrow</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate from a pointer type by borrowing. Don't increase the refcount</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.FromGlibPtrContainer.html"
|
||
title='trait glib::translate::FromGlibPtrContainer'>FromGlibPtrContainer</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate from a container of pointers.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.FromGlibPtrFull.html"
|
||
title='trait glib::translate::FromGlibPtrFull'>FromGlibPtrFull</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate from a pointer type taking ownership, transfer: full.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.FromGlibPtrNone.html"
|
||
title='trait glib::translate::FromGlibPtrNone'>FromGlibPtrNone</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate from a pointer type without taking ownership, transfer: none.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.GlibPtrDefault.html"
|
||
title='trait glib::translate::GlibPtrDefault'>GlibPtrDefault</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Provides the default pointer type to be used in some container conversions.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Ptr.html"
|
||
title='trait glib::translate::Ptr'>Ptr</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A pointer</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.ToBool.html"
|
||
title='trait glib::translate::ToBool'>ToBool</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.ToGlib.html"
|
||
title='trait glib::translate::ToGlib'>ToGlib</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate a simple type.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.ToGlibContainerFromSlice.html"
|
||
title='trait glib::translate::ToGlibContainerFromSlice'>ToGlibContainerFromSlice</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.ToGlibPtr.html"
|
||
title='trait glib::translate::ToGlibPtr'>ToGlibPtr</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate to a pointer.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.ToGlibPtrMut.html"
|
||
title='trait glib::translate::ToGlibPtrMut'>ToGlibPtrMut</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate to a pointer with a mutable borrow.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Uninitialized.html"
|
||
title='trait glib::translate::Uninitialized'>Uninitialized</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A trait for creating an uninitialized value. Handy for receiving outparams.</p>
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.c_ptr_array_len.html"
|
||
title='fn glib::translate::c_ptr_array_len'>c_ptr_array_len</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.from_glib.html"
|
||
title='fn glib::translate::from_glib'>from_glib</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate a simple type.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.from_glib_borrow.html"
|
||
title='fn glib::translate::from_glib_borrow'>from_glib_borrow</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate from a pointer type, borrowing the pointer.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.from_glib_full.html"
|
||
title='fn glib::translate::from_glib_full'>from_glib_full</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate from a pointer type, transfer: full (assume ownership).</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.from_glib_none.html"
|
||
title='fn glib::translate::from_glib_none'>from_glib_none</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
|
||
<td class='docblock-short'>
|
||
<p>Translate from a pointer type, transfer: none.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.mut_override.html"
|
||
title='fn glib::translate::mut_override'>mut_override</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Overrides pointer mutability.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.some_if.html"
|
||
title='fn glib::translate::some_if'>some_if</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Returns <code>Some(val)</code> if the condition is true and <code>None</code> otherwise.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.uninitialized.html"
|
||
title='fn glib::translate::uninitialized'>uninitialized</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
|
||
<td class='docblock-short'>
|
||
<p>Returns an uninitialized value.</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> |