<!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="Source to the Rust file `/home/mrh/.cargo/registry/src/github.com-1ecc6299db9ec823/wayland-client-0.21.13/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs.html -- source</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 source"><!--[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_client/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! Client-side Wayland connector</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Overview</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This crate provides the interfaces and machinery to safely create</span>
<span class="doccomment">//! client applications for the wayland protocol. It is a rust wrapper</span>
<span class="doccomment">//! around the `libwayland-client.so` C library.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The wayland protocol revolves around the creation of various objects</span>
<span class="doccomment">//! and the exchange of messages associated to these objects. The initial</span>
<span class="doccomment">//! object is always the `Display`, that you get at initialization of the</span>
<span class="doccomment">//! connection, exposed by this crate as `Display::connect_to_env()`.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Protocol and messages handling model</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The protocol being bi-directional, you can send and receive messages.</span>
<span class="doccomment">//! Sending messages is done via methods of `Proxy<_>` objects, receiving</span>
<span class="doccomment">//! and handling them is done by providing implementations.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ### Proxies</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Wayland protocol objects are represented in this crate by `Proxy<I>`</span>
<span class="doccomment">//! objects, where `I` is a type representing the interface of the considered</span>
<span class="doccomment">//! object. And object's interface (think "class" in an object-oriented context)</span>
<span class="doccomment">//! defines which messages it can send and receive.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! These proxies are used to send messages to the server (in the wayland context,</span>
<span class="doccomment">//! these are called "requests"). To do so, you need to import the appropriate</span>
<span class="doccomment">//! extension trait adding these methods. For example, to use a `Proxy<WlSurface>`,</span>
<span class="doccomment">//! you need to import `protocol::wl_surface::RequestsTrait` from this crate.</span>
<span class="doccomment">//! It is also possible to directly use the `Proxy::<I>::send(..)` method, but</span>
<span class="doccomment">//! this should only be done carefully: using it improperly can mess the protocol</span>
<span class="doccomment">//! state and cause protocol errors, which are fatal to the connection (the server</span>
<span class="doccomment">//! will kill you).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! There is not a 1 to 1 mapping between `Proxy<I>` instances and protocol</span>
<span class="doccomment">//! objects. Rather, you can think of `Proxy<I>` as an `Rc`-like handle to a</span>
<span class="doccomment">//! wayland object. Multiple instances of it can exist referring to the same</span>
<span class="doccomment">//! protocol object.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Similarly, the lifetimes of the protocol objects and the `Proxy<I>` are</span>
<span class="doccomment">//! not tightly tied. As protocol objects are created and destroyed by protocol</span>
<span class="doccomment">//! messages, it can happen that an object gets destroyed while one or more</span>
<span class="doccomment">//! `Proxy<I>` still refers to it. In such case, these proxies will be disabled</span>
<span class="doccomment">//! and their `alive()` method will start to return `false`. Trying to send messages</span>
<span class="doccomment">//! with them will also fail.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ### Implementations</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! To receive and process messages from the server to you (in wayland context they are</span>
<span class="doccomment">//! called "events"), you need to provide an `Implementation` for each wayland object</span>
<span class="doccomment">//! created in the protocol session. Whenever a new protocol object is created, you will</span>
<span class="doccomment">//! receive a `NewProxy<I>` object. Providing an implementation via its `implement()` method</span>
<span class="doccomment">//! will turn it into a regular `Proxy<I>` object.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! **All objects must be implemented**, even if it is an implementation doing nothing.</span>
<span class="doccomment">//! Failure to do so (by dropping the `NewProxy<I>` for example) can cause future fatal</span>
<span class="doccomment">//! errors if the server tries to send an event to this object.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! An implementation is just an `FnMut(I::Event, Proxy<I>), where `I` is the interface of</span>
<span class="doccomment">//! the considered object.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Event Queues</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The wayland client machinery provides the possibility to have one or more event queues</span>
<span class="doccomment">//! handling the processing of received messages. All wayland objects are associated to an</span>
<span class="doccomment">//! event queue, which controls when its events are dispatched.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Events received from the server are stored in an internal buffer, and processed (by calling</span>
<span class="doccomment">//! the appropriate implementations) when the associated event queue is dispatched.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! A default event queue is created at the same time as the initial `Display`, and by default</span>
<span class="doccomment">//! whenever a wayland object is created, it inherits the queue of its parent (the object that sent</span>
<span class="doccomment">//! or receive the message that created the new object). It means that if you only plan to use the</span>
<span class="doccomment">//! default event queue, you don't need to worry about assigning objects to their queues.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! See the documentation of `EventQueue` for details about dispatching and integrating the event</span>
<span class="doccomment">//! queue into the event loop of your application. See the `Proxy::make_wrapper()` method for</span>
<span class="doccomment">//! details about assigning objects to event queues.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Dynamic linking with `libwayland-client.so`</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! If you need to gracefully handle the case of a system on which wayland is not installed (by</span>
<span class="doccomment">//! fallbacking to X11 for example), you can do so by activating the `dlopen` cargo feature.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! When this is done, the library will be loaded a runtime rather than directly linked. And trying</span>
<span class="doccomment">//! to create a `Display` on a system that does not have this library will return a `NoWaylandLib`</span>
<span class="doccomment">//! error.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Auxiliary libraries</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Two auxiliary libraries are also available behind cargo features:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - the `cursor` feature will try to load `libwayland-cursor.so`, a library helping with loading</span>
<span class="doccomment">//! system themed cursor textures, to integrate your app in the system theme.</span>
<span class="doccomment">//! - the `egl` feature will try to load `libwayland-egl.so`, a library allowing the creation of</span>
<span class="doccomment">//! OpenGL surface from wayland surfaces.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Both of them will also be loaded at runtime if the `dlopen` feature was provided. See their</span>
<span class="doccomment">//! respective submodules for details about their use.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ### Event Loop integration</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The `eventloop` cargo feature adds the necessary implementations to use an `EventQueue`</span>
<span class="doccomment">//! as a `calloop` event source. If you want to use it, here are a few points to take into</span>
<span class="doccomment">//! account:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - The `EventQueue` will not call its associated callback, but rather manage all the</span>
<span class="doccomment">//! event dispatching internally. As a result, there is no point registering it to</span>
<span class="doccomment">//! `calloop` with anything other than a dummy callback.</span>
<span class="doccomment">//! - You still need to call `Display::flush()` yourself between `calloop`s dispatches,</span>
<span class="doccomment">//! or in the `EventLoop::run()` callback of `calloop`.</span>
<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">missing_docs</span>)]</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">bitflags</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>))]</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">downcast_rs</span> <span class="kw">as</span> <span class="ident">downcast</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">libc</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">nix</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"eventloop"</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">calloop</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"eventloop"</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">mio</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">wayland_commons</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>)]</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">wayland_sys</span>;
<span class="kw">mod</span> <span class="ident">display</span>;
<span class="kw">mod</span> <span class="ident">event_queue</span>;
<span class="kw">mod</span> <span class="ident">globals</span>;
<span class="kw">mod</span> <span class="ident">proxy</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">display</span>::{<span class="ident">ConnectError</span>, <span class="ident">Display</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">event_queue</span>::{<span class="ident">EventQueue</span>, <span class="ident">QueueToken</span>, <span class="ident">ReadEventsGuard</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">globals</span>::{<span class="ident">GlobalError</span>, <span class="ident">GlobalEvent</span>, <span class="ident">GlobalImplementor</span>, <span class="ident">GlobalManager</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">imp</span>::<span class="ident">ProxyMap</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">proxy</span>::{<span class="ident">NewProxy</span>, <span class="ident">Proxy</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cursor"</span>)]</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">cursor</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"egl"</span>)]</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">egl</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">wayland_commons</span>::{<span class="ident">AnonymousObject</span>, <span class="ident">Interface</span>, <span class="ident">MessageGroup</span>, <span class="ident">NoMessage</span>};
<span class="comment">// rust implementation</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>))]</span>
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"rust_imp/mod.rs"</span>]</span>
<span class="kw">mod</span> <span class="ident">imp</span>;
<span class="comment">// C-lib based implementation</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>)]</span>
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"native_lib/mod.rs"</span>]</span>
<span class="kw">mod</span> <span class="ident">imp</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>)]</span>
<span class="doccomment">/// C-associated types</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Required for plugging wayland-scanner generated protocols</span>
<span class="doccomment">/// or interfacing with C code using wayland objects.</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">sys</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">generated</span>::<span class="ident">c_interfaces</span> <span class="kw">as</span> <span class="ident">protocol_interfaces</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">wayland_sys</span>::{<span class="ident">client</span>, <span class="ident">common</span>};
}
<span class="doccomment">/// Generated interfaces for the core wayland protocol</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">protocol</span> {
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">generated</span>::<span class="ident">c_api</span>::<span class="kw-2">*</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>))]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">generated</span>::<span class="ident">rust_api</span>::<span class="kw-2">*</span>;
}
<span class="kw">mod</span> <span class="ident">generated</span> {
<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">dead_code</span>, <span class="ident">non_camel_case_types</span>, <span class="ident">unused_unsafe</span>, <span class="ident">unused_variables</span>)]</span>
<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>, <span class="ident">non_snake_case</span>, <span class="ident">unused_imports</span>)]</span>
<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">missing_docs</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>)]</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">c_interfaces</span> {
<span class="macro">include</span><span class="macro">!</span>(<span class="macro">concat</span><span class="macro">!</span>(<span class="macro">env</span><span class="macro">!</span>(<span class="string">"OUT_DIR"</span>), <span class="string">"/wayland_c_interfaces.rs"</span>));
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>)]</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">c_api</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">wayland_commons</span>::<span class="ident">map</span>::{<span class="ident">Object</span>, <span class="ident">ObjectMetadata</span>};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">wayland_commons</span>::<span class="ident">wire</span>::{<span class="ident">Argument</span>, <span class="ident">ArgumentType</span>, <span class="ident">Message</span>, <span class="ident">MessageDesc</span>};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">wayland_commons</span>::{<span class="ident">AnonymousObject</span>, <span class="ident">Interface</span>, <span class="ident">MessageGroup</span>};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">wayland_sys</span> <span class="kw">as</span> <span class="ident">sys</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> {<span class="ident">NewProxy</span>, <span class="ident">Proxy</span>, <span class="ident">ProxyMap</span>};
<span class="macro">include</span><span class="macro">!</span>(<span class="macro">concat</span><span class="macro">!</span>(<span class="macro">env</span><span class="macro">!</span>(<span class="string">"OUT_DIR"</span>), <span class="string">"/wayland_c_api.rs"</span>));
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"native_lib"</span>))]</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">rust_api</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">wayland_commons</span>::<span class="ident">map</span>::{<span class="ident">Object</span>, <span class="ident">ObjectMetadata</span>};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">wayland_commons</span>::<span class="ident">wire</span>::{<span class="ident">Argument</span>, <span class="ident">ArgumentType</span>, <span class="ident">Message</span>, <span class="ident">MessageDesc</span>};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">wayland_commons</span>::{<span class="ident">AnonymousObject</span>, <span class="ident">Interface</span>, <span class="ident">MessageGroup</span>};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> {<span class="ident">NewProxy</span>, <span class="ident">Proxy</span>, <span class="ident">ProxyMap</span>};
<span class="macro">include</span><span class="macro">!</span>(<span class="macro">concat</span><span class="macro">!</span>(<span class="macro">env</span><span class="macro">!</span>(<span class="string">"OUT_DIR"</span>), <span class="string">"/wayland_rust_api.rs"</span>));
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"eventloop"</span>)]</span>
<span class="kw">impl</span> ::<span class="ident">mio</span>::<span class="ident">event</span>::<span class="ident">Evented</span> <span class="kw">for</span> <span class="ident">EventQueue</span> {
<span class="kw">fn</span> <span class="ident">register</span>(
<span class="kw-2">&</span><span class="self">self</span>,
<span class="ident">poll</span>: <span class="kw-2">&</span>::<span class="ident">mio</span>::<span class="ident">Poll</span>,
<span class="ident">token</span>: ::<span class="ident">mio</span>::<span class="ident">Token</span>,
<span class="ident">interest</span>: ::<span class="ident">mio</span>::<span class="ident">Ready</span>,
<span class="ident">opts</span>: ::<span class="ident">mio</span>::<span class="ident">PollOpt</span>,
) <span class="op">-</span><span class="op">></span> ::<span class="ident">std</span>::<span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
<span class="kw">let</span> <span class="ident">fd</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_connection_fd</span>();
::<span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">EventedFd</span>(<span class="kw-2">&</span><span class="ident">fd</span>).<span class="ident">register</span>(<span class="ident">poll</span>, <span class="ident">token</span>, <span class="ident">interest</span>, <span class="ident">opts</span>)
}
<span class="kw">fn</span> <span class="ident">reregister</span>(
<span class="kw-2">&</span><span class="self">self</span>,
<span class="ident">poll</span>: <span class="kw-2">&</span>::<span class="ident">mio</span>::<span class="ident">Poll</span>,
<span class="ident">token</span>: ::<span class="ident">mio</span>::<span class="ident">Token</span>,
<span class="ident">interest</span>: ::<span class="ident">mio</span>::<span class="ident">Ready</span>,
<span class="ident">opts</span>: ::<span class="ident">mio</span>::<span class="ident">PollOpt</span>,
) <span class="op">-</span><span class="op">></span> ::<span class="ident">std</span>::<span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
<span class="kw">let</span> <span class="ident">fd</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_connection_fd</span>();
::<span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">EventedFd</span>(<span class="kw-2">&</span><span class="ident">fd</span>).<span class="ident">reregister</span>(<span class="ident">poll</span>, <span class="ident">token</span>, <span class="ident">interest</span>, <span class="ident">opts</span>)
}
<span class="kw">fn</span> <span class="ident">deregister</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">poll</span>: <span class="kw-2">&</span>::<span class="ident">mio</span>::<span class="ident">Poll</span>) <span class="op">-</span><span class="op">></span> ::<span class="ident">std</span>::<span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
<span class="kw">let</span> <span class="ident">fd</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_connection_fd</span>();
::<span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">EventedFd</span>(<span class="kw-2">&</span><span class="ident">fd</span>).<span class="ident">deregister</span>(<span class="ident">poll</span>)
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"eventloop"</span>)]</span>
<span class="kw">impl</span> ::<span class="ident">calloop</span>::<span class="ident">EventSource</span> <span class="kw">for</span> <span class="ident">EventQueue</span> {
<span class="kw">type</span> <span class="ident">Event</span> <span class="op">=</span> ();
<span class="kw">fn</span> <span class="ident">interest</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> ::<span class="ident">mio</span>::<span class="ident">Ready</span> {
::<span class="ident">mio</span>::<span class="ident">Ready</span>::<span class="ident">readable</span>()
}
<span class="kw">fn</span> <span class="ident">pollopts</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> ::<span class="ident">mio</span>::<span class="ident">PollOpt</span> {
::<span class="ident">mio</span>::<span class="ident">PollOpt</span>::<span class="ident">edge</span>()
}
<span class="kw">fn</span> <span class="ident">make_dispatcher</span><span class="op"><</span><span class="ident">Data</span>: <span class="lifetime">'static</span>, <span class="ident">F</span>: <span class="ident">FnMut</span>((), <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Data</span>) <span class="op">+</span> <span class="lifetime">'static</span><span class="op">></span>(
<span class="kw-2">&</span><span class="self">self</span>,
<span class="ident">_callback</span>: <span class="ident">F</span>,
) <span class="op">-</span><span class="op">></span> ::<span class="ident">std</span>::<span class="ident">rc</span>::<span class="ident">Rc</span><span class="op"><</span>::<span class="ident">std</span>::<span class="ident">cell</span>::<span class="ident">RefCell</span><span class="op"><</span>::<span class="ident">calloop</span>::<span class="ident">EventDispatcher</span><span class="op"><</span><span class="ident">Data</span><span class="op">></span><span class="op">></span><span class="op">></span> {
<span class="kw">struct</span> <span class="ident">Dispatcher</span> {
<span class="ident">inner</span>: ::<span class="ident">std</span>::<span class="ident">rc</span>::<span class="ident">Rc</span><span class="op"><</span>::<span class="ident">imp</span>::<span class="ident">EventQueueInner</span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Data</span><span class="op">></span> ::<span class="ident">calloop</span>::<span class="ident">EventDispatcher</span><span class="op"><</span><span class="ident">Data</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Dispatcher</span> {
<span class="kw">fn</span> <span class="ident">ready</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">_ready</span>: ::<span class="ident">mio</span>::<span class="ident">Ready</span>, <span class="ident">_data</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Data</span>) {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Err</span>(()) <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">prepare_read</span>() {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">dispatch_pending</span>().<span class="ident">unwrap</span>();
} <span class="kw">else</span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">read_events</span>() {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">dispatch_pending</span>().<span class="ident">unwrap</span>();
}
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="kw">match</span> <span class="ident">e</span>.<span class="ident">kind</span>() {
::<span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {}
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> {
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Failed to read from wayland socket: {}"</span>, <span class="ident">e</span>);
}
},
}
}
}
}
::<span class="ident">std</span>::<span class="ident">rc</span>::<span class="ident">Rc</span>::<span class="ident">new</span>(::<span class="ident">std</span>::<span class="ident">cell</span>::<span class="ident">RefCell</span>::<span class="ident">new</span>(<span class="ident">Dispatcher</span> {
<span class="ident">inner</span>: <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">clone</span>(),
}))
}
}
</pre></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 src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>