|
|
|
|
|
<!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 `Interface` trait in crate `wayland_commons`."><meta name="keywords" content="rust, rustlang, rust-lang, Interface"><title>wayland_commons::Interface - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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><a href='../wayland_commons/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Interface</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Request">Request</a><a href="#associatedtype.Event">Event</a></div><a class="sidebar-title" href="#associated-const">Associated Constants</a><div class="sidebar-links"><a href="#associatedconstant.NAME">NAME</a><a href="#associatedconstant.VERSION">VERSION</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.c_interface">c_interface</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>wayland_commons</a></p><script>window.sidebarCurrent = {name: 'Interface', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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#79-95' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>wayland_commons</a>::<wbr><a class="trait" href=''>Interface</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Interface: 'static {
|
|
|
|
|
|
type <a href='#associatedtype.Request' class="type">Request</a>: <a class="trait" href="../wayland_commons/trait.MessageGroup.html" title="trait wayland_commons::MessageGroup">MessageGroup</a> + 'static;
|
|
|
|
|
|
type <a href='#associatedtype.Event' class="type">Event</a>: <a class="trait" href="../wayland_commons/trait.MessageGroup.html" title="trait wayland_commons::MessageGroup">MessageGroup</a> + 'static;
|
|
|
|
|
|
|
|
|
|
|
|
const <a href='#associatedconstant.NAME' class="constant"><b>NAME</b></a>: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>;
|
|
|
|
|
|
const <a href='#associatedconstant.VERSION' class="constant"><b>VERSION</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#tymethod.c_interface' class='fnname'>c_interface</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="struct" href="../wayland_sys/common/struct.wl_interface.html" title="struct wayland_sys::common::wl_interface">wl_interface</a>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>The description of a wayland interface</p>
|
|
|
|
|
|
<p>Implementations of this trait are supposed to be
|
|
|
|
|
|
generated using the <code>wayland-scanner</code> crate.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Request' class='method'><code id='Request.t'>type <a href='#associatedtype.Request' class="type">Request</a>: <a class="trait" href="../wayland_commons/trait.MessageGroup.html" title="trait wayland_commons::MessageGroup">MessageGroup</a> + 'static</code></h3><div class='docblock'><p>Set of requests associated to this interface</p>
|
|
|
|
|
|
<p>Requests are messages from the client to the server</p>
|
|
|
|
|
|
</div><h3 id='associatedtype.Event' class='method'><code id='Event.t'>type <a href='#associatedtype.Event' class="type">Event</a>: <a class="trait" href="../wayland_commons/trait.MessageGroup.html" title="trait wayland_commons::MessageGroup">MessageGroup</a> + 'static</code></h3><div class='docblock'><p>Set of events associated to this interface</p>
|
|
|
|
|
|
<p>Events are messages from the server to the client</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='associated-const' class='small-section-header'>Associated Constants<a href='#associated-const' class='anchor'></a></h2><div class='methods'><h3 id='associatedconstant.NAME' class='method'><code id='NAME.v'>const <a href='#associatedconstant.NAME' class="constant"><b>NAME</b></a>: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></h3><div class='docblock'><p>Name of this interface</p>
|
|
|
|
|
|
</div><h3 id='associatedconstant.VERSION' class='method'><code id='VERSION.v'>const <a href='#associatedconstant.VERSION' class="constant"><b>VERSION</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><div class='docblock'><p>Maximum supported version of this interface</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.c_interface' class='method'><code id='c_interface.v'>fn <a href='#tymethod.c_interface' class='fnname'>c_interface</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="struct" href="../wayland_sys/common/struct.wl_interface.html" title="struct wayland_sys::common::wl_interface">wl_interface</a></code></h3><div class='docblock'><p>Pointer to the C representation of this interface</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Interface' class='impl'><code class='in-band'>impl Interface for <a class="struct" href="../wayland_commons/struct.AnonymousObject.html" title="struct wayland_commons::AnonymousObject">AnonymousObject</a></code><a href='#impl-Interface' class='anchor'></a><a class='srclink' href='../src/wayland_commons/lib.rs.html#106-115' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Request-1' class="type"><code id='Request.t-1'>type <a href='#associatedtype.Request-1' class="type">Request</a> = <a class="enum" href="../wayland_commons/enum.NoMessage.html" title="enum wayland_commons::NoMessage">NoMessage</a></code></h4><h4 id='associatedtype.Event-1' class="type"><code id='Event.t-1'>type <a href='#associatedtype.Event-1' class="type">Event</a> = <a class="enum" href="../wayland_commons/enum.NoMessage.html" title="enum wayland_commons::NoMessage">NoMessage</a></code></h4><h4 id='associatedconstant.NAME-1' class="associatedconstant hidden"><code id='NAME.v-1'>const <a href='#associatedconstant.NAME-1' class="constant"><b>NAME</b></a>: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a class='srclink' href='../src/wayland_commons/lib.rs.html#109' title='goto source code'>[src]</a></h4><h4 id='associatedconstant.VERSION-1' class="associatedconstant hidden"><code id='VERSION.v-1'>const <a href='#associatedconstant.VERSION-1' class="constant"><b>VERSION</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../src/wayland_commons/lib.rs.html#110' title='goto source code'>[src]</a></h4><h4 id='method.c_interface' class="method hidden"><code id='c_interface.v-1'>fn <a href='#method.c_interface' class='fnname'>c_interface</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="struct" href="../wayland_sys/common/struct.wl_interface.html" title="struct wayland_sys::common::wl_interface">wl_interface</a></code><a class='srclink' href='../src/wayland_commons/lib.rs.html#112-114' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../implementors/wayland_commons/trait.Interface.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>
|
