2018-10-28 21:14:05 -05:00

64 lines
7.3 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 `wayland_commons` crate."><meta name="keywords" content="rust, rustlang, rust-lang, wayland_commons"><title>wayland_commons - 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 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"><div class="sidebar-menu">&#9776;</div><p class='location'>Crate wayland_commons</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'wayland_commons', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>wayland_commons</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/wayland_commons/lib.rs.html#1-159' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Common definitions for wayland</p>
<p>This crate hosts common type and traits used to represent wayland messages
and routines in the <code>wayland-client</code> and <code>wayland-server</code> crates.</p>
<p>This notably includes the <code>Interface</code> trait, which can exhaustively describe
any wayland interface. Its implementations are intented to be generated by the
<code>wayland-scanner</code> crate.</p>
<p>The principal user-facing definition provided by this crate is the <code>Implementation</code>
trait, which as a user of <code>wayland-client</code> or <code>wayland-server</code> you will be using
to define objects able to handle the messages your program receives. Note that
this trait is auto-implemented for closures with appropriate signature, for
convenience.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.AnonymousObject.html"
title='struct wayland_commons::AnonymousObject'>AnonymousObject</a></td>
<td class='docblock-short'>
<p>Anonymous interface</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.NoMessage.html"
title='enum wayland_commons::NoMessage'>NoMessage</a></td>
<td class='docblock-short'>
<p>An empty enum representing a MessageGroup with no messages</p>
</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.Implementation.html"
title='trait wayland_commons::Implementation'>Implementation</a></td>
<td class='docblock-short'>
<p>Trait representing implementations for wayland objects</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.Interface.html"
title='trait wayland_commons::Interface'>Interface</a></td>
<td class='docblock-short'>
<p>The description of a wayland interface</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.MessageGroup.html"
title='trait wayland_commons::MessageGroup'>MessageGroup</a></td>
<td class='docblock-short'>
<p>A group of messages</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.downcast_impl.html"
title='fn wayland_commons::downcast_impl'>downcast_impl</a></td>
<td class='docblock-short'>
<p>Attempt to downcast a boxed <code>Implementation</code> trait object.</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><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>&#9166;</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>