mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
31 lines
11 KiB
HTML
31 lines
11 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 `Implementation` trait in crate `wayland_commons`."><meta name="keywords" content="rust, rustlang, rust-lang, Implementation"><title>wayland_commons::Implementation - 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 trait"><!--[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'>Trait Implementation</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.receive">receive</a></div><a class="sidebar-title" href="#implementors">Implementors</a><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.is">is</a><a href="#method.downcast">downcast</a><a href="#method.downcast_ref">downcast_ref</a><a href="#method.downcast_mut">downcast_mut</a></div></div><p class='location'><a href='index.html'>wayland_commons</a></p><script>window.sidebarCurrent = {name: 'Implementation', ty: 'trait', 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'>Trait <a href='index.html'>wayland_commons</a>::<wbr><a class="trait" href=''>Implementation</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_commons/lib.rs.html#91-94' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Implementation<Meta, Msg>: <a class="trait" href="../downcast_rs/trait.Downcast.html" title="trait downcast_rs::Downcast">Downcast</a> {
|
||
fn <a href='#tymethod.receive' class='fnname'>receive</a>(&mut self, msg: Msg, meta: Meta);
|
||
}</pre></div><div class='docblock'><p>Trait representing implementations for wayland objects</p>
|
||
<p>Several wayland objects require you to act when some messages
|
||
are received. You program this act by providing an object
|
||
implementing this trait.</p>
|
||
<p>The trait requires a single method: <code>self.receive(message, metadata)</code>.
|
||
the <code>message</code> argument will often be an enum of the possible messages,
|
||
and the <code>metadata</code> argument contains associated information. Typically
|
||
an handle to the wayland object that received this message.</p>
|
||
<p>The trait is automatically implemented for <code>FnMut(Msg, Meta)</code> closures.</p>
|
||
<p>This is mostly used as a trait object in <code>wayland-client</code> and <code>wayland-server</code>,
|
||
and thus also provide methods providing <code>Any</code>-like downcasting functionnality.
|
||
See also the <code>downcast_impl</code> freestanding function.</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>
|
||
Required Methods<a href='#required-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.receive' class='method'><span id='receive.v' class='invisible'><code>fn <a href='#tymethod.receive' class='fnname'>receive</a>(&mut self, msg: Msg, meta: Meta)</code></span></h3><div class='docblock'><p>Receive a message</p>
|
||
</div></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<Meta, Msg> <a class="trait" href="../wayland_commons/trait.Implementation.html" title="trait wayland_commons::Implementation">Implementation</a><Meta, Msg> <span class="where fmt-newline">where<br> Meta: <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static,<br> Msg: <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static, </span></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.is' class="method"><span id='is.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is' class='fnname'>is</a><__T: <a class="trait" href="../wayland_commons/trait.Implementation.html" title="trait wayland_commons::Implementation">Implementation</a><Meta, Msg>>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns true if the trait object wraps an object of type <code>__T</code>.</p>
|
||
</div><h4 id='method.downcast' class="method"><span id='downcast.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.downcast' class='fnname'>downcast</a><__T: <a class="trait" href="../wayland_commons/trait.Implementation.html" title="trait wayland_commons::Implementation">Implementation</a><Meta, Msg>>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><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="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><__T>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a boxed object from a boxed trait object if the underlying object is of type
|
||
<code>__T</code>. Returns the original boxed trait if it isn't.</p>
|
||
</div><h4 id='method.downcast_ref' class="method"><span id='downcast_ref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.downcast_ref' class='fnname'>downcast_ref</a><__T: <a class="trait" href="../wayland_commons/trait.Implementation.html" title="trait wayland_commons::Implementation">Implementation</a><Meta, Msg>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>__T></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the object within the trait object if it is of type <code>__T</code>, or
|
||
<code>None</code> if it isn't.</p>
|
||
</div><h4 id='method.downcast_mut' class="method"><span id='downcast_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.downcast_mut' class='fnname'>downcast_mut</a><__T: <a class="trait" href="../wayland_commons/trait.Implementation.html" title="trait wayland_commons::Implementation">Implementation</a><Meta, Msg>>(<br> &mut self<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>__T></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a mutable reference to the object within the trait object if it is of type
|
||
<code>__T</code>, or <code>None</code> if it isn't.</p>
|
||
</div></div><h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><ul class='item-list' id='implementors-list'><li><table class='table-display'><tbody><tr><td><code>impl<Meta, Msg, F> Implementation<Meta, Msg> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Msg, Meta) + 'static, </span></code><td><div class='out-of-band'><a class='srclink' href='../src/wayland_commons/lib.rs.html#98-105' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/wayland_commons/trait.Implementation.js">
|
||
</script></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_commons";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |