mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
21 lines
16 KiB
HTML
21 lines
16 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 `GlobalManager` struct in crate `wayland_client`."><meta name="keywords" content="rust, rustlang, rust-lang, GlobalManager"><title>wayland_client::GlobalManager - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></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"><div class="sidebar-menu">☰</div><p class='location'>Struct GlobalManager</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.new_with_cb">new_with_cb</a><a href="#method.instantiate_auto">instantiate_auto</a><a href="#method.instantiate_exact">instantiate_exact</a><a href="#method.list">list</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>wayland_client</a></p><script>window.sidebarCurrent = {name: 'GlobalManager', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><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"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>wayland_client</a>::<wbr><a class="struct" href=''>GlobalManager</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/wayland_client/globals.rs.html#18-21' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct GlobalManager { /* fields omitted */ }</pre></div><div class='docblock'><p>An utility to manage global objects</p>
|
||
<p>This utility provides an implemenation for the registry
|
||
that track the list of globals for you, as well as utilities
|
||
to bind them.</p>
|
||
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../wayland_client/struct.GlobalManager.html" title="struct wayland_client::GlobalManager">GlobalManager</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/wayland_client/globals.rs.html#53-194' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(registry: <a class="struct" href="../wayland_client/struct.NewProxy.html" title="struct wayland_client::NewProxy">NewProxy</a><<a class="struct" href="../wayland_client/protocol/wl_registry/struct.WlRegistry.html" title="struct wayland_client::protocol::wl_registry::WlRegistry">WlRegistry</a>>) -> <a class="struct" href="../wayland_client/struct.GlobalManager.html" title="struct wayland_client::GlobalManager">GlobalManager</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/wayland_client/globals.rs.html#55-82' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a global manager handling a registry</p>
|
||
</div><h4 id='method.new_with_cb' class="method"><span id='new_with_cb.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new_with_cb' class='fnname'>new_with_cb</a><Impl>(<br> registry: <a class="struct" href="../wayland_client/struct.NewProxy.html" title="struct wayland_client::NewProxy">NewProxy</a><<a class="struct" href="../wayland_client/protocol/wl_registry/struct.WlRegistry.html" title="struct wayland_client::protocol::wl_registry::WlRegistry">WlRegistry</a>>, <br> callback: Impl<br>) -> <a class="struct" href="../wayland_client/struct.GlobalManager.html" title="struct wayland_client::GlobalManager">GlobalManager</a> <span class="where fmt-newline">where<br> Impl: <a class="trait" href="../wayland_client/commons/trait.Implementation.html" title="trait wayland_client::commons::Implementation">Implementation</a><<a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a><<a class="struct" href="../wayland_client/protocol/wl_registry/struct.WlRegistry.html" title="struct wayland_client::protocol::wl_registry::WlRegistry">WlRegistry</a>>, <a class="enum" href="../wayland_client/enum.GlobalEvent.html" title="enum wayland_client::GlobalEvent">GlobalEvent</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/wayland_client/globals.rs.html#91-143' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a global manager handling a registry with a callback</p>
|
||
<p>This global manager will track globals as a simple one, but will
|
||
also forward the registry events to your callback.</p>
|
||
<p>This can be used if you want to handle specially certain globals, but want
|
||
to use the default mechanism for the rest.</p>
|
||
</div><h4 id='method.instantiate_auto' class="method"><span id='instantiate_auto.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.instantiate_auto' class='fnname'>instantiate_auto</a><I: <a class="trait" href="../wayland_client/commons/trait.Interface.html" title="trait wayland_client::commons::Interface">Interface</a>>(&self) -> <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="../wayland_client/struct.NewProxy.html" title="struct wayland_client::NewProxy">NewProxy</a><I>, <a class="enum" href="../wayland_client/enum.GlobalError.html" title="enum wayland_client::GlobalError">GlobalError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/wayland_client/globals.rs.html#150-158' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Instanciate a global with highest available version</p>
|
||
<p>This method is only appropriate for globals that are expected to
|
||
not exist with multiplicity (sur as <code>wl_compositor</code> or <code>wl_shm</code>),
|
||
as it will only bind a single one.</p>
|
||
</div><h4 id='method.instantiate_exact' class="method"><span id='instantiate_exact.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.instantiate_exact' class='fnname'>instantiate_exact</a><I: <a class="trait" href="../wayland_client/commons/trait.Interface.html" title="trait wayland_client::commons::Interface">Interface</a>>(<br> &self, <br> version: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><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="../wayland_client/struct.NewProxy.html" title="struct wayland_client::NewProxy">NewProxy</a><I>, <a class="enum" href="../wayland_client/enum.GlobalError.html" title="enum wayland_client::GlobalError">GlobalError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/wayland_client/globals.rs.html#170-182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Instanciate a global with a specific version</p>
|
||
<p>Like <code>instantiate_auto</code>, but will bind a specific version of
|
||
this global an not the highest available.</p>
|
||
</div><h4 id='method.list' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></h3><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></span></code></div></div><span id='list.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.list' class='fnname'>list</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/wayland_client/globals.rs.html#191-193' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Retrieve the list of currently known globals</p>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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="../wayland_client/struct.GlobalManager.html" title="struct wayland_client::GlobalManager">GlobalManager</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/wayland_client/globals.rs.html#17' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../wayland_client/struct.GlobalManager.html" title="struct wayland_client::GlobalManager">GlobalManager</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/wayland_client/globals.rs.html#17' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></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></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../wayland_client/struct.GlobalManager.html" title="struct wayland_client::GlobalManager">GlobalManager</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../wayland_client/struct.GlobalManager.html" title="struct wayland_client::GlobalManager">GlobalManager</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "wayland_client";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |