<!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/display.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>display.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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">env</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">OsString</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">Deref</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">io</span>::{<span class="ident">IntoRawFd</span>, <span class="ident">RawFd</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">net</span>::<span class="ident">UnixStream</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">PathBuf</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
<span class="kw">use</span> <span class="ident">nix</span>::<span class="ident">fcntl</span>;
<span class="kw">use</span> {<span class="ident">EventQueue</span>, <span class="ident">Proxy</span>};
<span class="kw">use</span> <span class="ident">imp</span>::<span class="ident">DisplayInner</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">use</span> <span class="ident">wayland_sys</span>::<span class="ident">client</span>::<span class="ident">wl_display</span>;
<span class="doccomment">/// Enum representing the possible reasons why connecting to the wayland server failed</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ConnectError</span> {
<span class="doccomment">/// The library was compiled with the `dlopen` feature, and the `libwayland-client.so`</span>
<span class="doccomment">/// library could not be found at runtime</span>
<span class="ident">NoWaylandLib</span>,
<span class="doccomment">/// The `XDG_RUNTIME_DIR` variable is not set while it should be</span>
<span class="ident">XdgRuntimeDirNotSet</span>,
<span class="doccomment">/// Any needed library was found, but the listening socket of the server could not be</span>
<span class="doccomment">/// found.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Most of the time, this means that the program was not started from a wayland session.</span>
<span class="ident">NoCompositorListening</span>,
<span class="doccomment">/// The provided socket name is invalid</span>
<span class="ident">InvalidName</span>,
<span class="doccomment">/// The FD provided in `WAYLAND_SOCKET` was invalid</span>
<span class="ident">InvalidFd</span>,
}
<span class="kw">impl</span> ::<span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">ConnectError</span> {
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">str</span> {
<span class="kw">match</span> <span class="kw-2">*</span><span class="self">self</span> {
<span class="ident">ConnectError</span>::<span class="ident">NoWaylandLib</span> <span class="op">=</span><span class="op">></span> <span class="string">"Could not find libwayland-client.so."</span>,
<span class="ident">ConnectError</span>::<span class="ident">XdgRuntimeDirNotSet</span> <span class="op">=</span><span class="op">></span> <span class="string">"XDG_RUNTIME_DIR is not set."</span>,
<span class="ident">ConnectError</span>::<span class="ident">NoCompositorListening</span> <span class="op">=</span><span class="op">></span> <span class="string">"Could not find a listening wayland compositor."</span>,
<span class="ident">ConnectError</span>::<span class="ident">InvalidName</span> <span class="op">=</span><span class="op">></span> <span class="string">"The wayland socket name is invalid."</span>,
<span class="ident">ConnectError</span>::<span class="ident">InvalidFd</span> <span class="op">=</span><span class="op">></span> <span class="string">"The FD provided in WAYLAND_SOCKET is invalid."</span>,
}
}
}
<span class="kw">impl</span> ::<span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">ConnectError</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> ::<span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), ::<span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Error</span><span class="op">></span> {
<span class="ident">f</span>.<span class="ident">write_str</span>(::<span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span>::<span class="ident">description</span>(<span class="self">self</span>))
}
}
<span class="doccomment">/// A connection to a wayland server</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This object both represent the connection to the server, and as such</span>
<span class="doccomment">/// must be kept alive as long as you are connected, and contains the</span>
<span class="doccomment">/// primary `WlDisplay` wayland object, from which you can create all</span>
<span class="doccomment">/// your need objects. The inner `Proxy<WlDisplay>` can be accessed via</span>
<span class="doccomment">/// `Deref`.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Display</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">inner</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">DisplayInner</span><span class="op">></span>,
}
<span class="kw">impl</span> <span class="ident">Display</span> {
<span class="doccomment">/// Attempt to connect to a wayland server using the contents of the environment variables</span>
<span class="doccomment">///</span>
<span class="doccomment">/// First of all, if the `WAYLAND_SOCKET` environment variable is set, it'll try to interpret</span>
<span class="doccomment">/// it as a FD number to use</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If the `WAYLAND_DISPLAY` variable is set, it will try to connect to the socket it points</span>
<span class="doccomment">/// to. Otherwise, it will default to `wayland-0`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On success, you are given the `Display` object as well as the main `EventQueue` hosting</span>
<span class="doccomment">/// the `WlDisplay` wayland object.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This requires the `XDG_RUNTIME_DIR` variable to be properly set.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">connect_to_env</span>() <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(<span class="ident">Display</span>, <span class="ident">EventQueue</span>), <span class="ident">ConnectError</span><span class="op">></span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="ident">txt</span>) <span class="op">=</span> <span class="ident">env</span>::<span class="ident">var</span>(<span class="string">"WAYLAND_SOCKET"</span>) {
<span class="comment">// We should connect to the provided WAYLAND_SOCKET</span>
<span class="kw">let</span> <span class="ident">fd</span> <span class="op">=</span> <span class="ident">txt</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>().<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ConnectError</span>::<span class="ident">InvalidFd</span>)<span class="question-mark">?</span>;
<span class="comment">// set the CLOEXEC flag on this FD</span>
<span class="kw">let</span> <span class="ident">flags</span> <span class="op">=</span> <span class="ident">fcntl</span>::<span class="ident">fcntl</span>(<span class="ident">fd</span>, <span class="ident">fcntl</span>::<span class="ident">FcntlArg</span>::<span class="ident">F_GETFD</span>);
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">flags</span>
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">f</span><span class="op">|</span> <span class="ident">fcntl</span>::<span class="ident">FdFlag</span>::<span class="ident">from_bits</span>(<span class="ident">f</span>).<span class="ident">unwrap</span>() <span class="op">|</span> <span class="ident">fcntl</span>::<span class="ident">FdFlag</span>::<span class="ident">FD_CLOEXEC</span>)
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">f</span><span class="op">|</span> <span class="ident">fcntl</span>::<span class="ident">fcntl</span>(<span class="ident">fd</span>, <span class="ident">fcntl</span>::<span class="ident">FcntlArg</span>::<span class="ident">F_SETFD</span>(<span class="ident">f</span>)));
<span class="kw">match</span> <span class="ident">result</span> {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> {
<span class="comment">// setting the O_CLOEXEC worked</span>
<span class="kw">unsafe</span> { <span class="ident">Display</span>::<span class="ident">from_fd</span>(<span class="ident">fd</span>) }
}
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> {
<span class="comment">// something went wrong in F_GETFD or F_SETFD</span>
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> ::<span class="ident">nix</span>::<span class="ident">unistd</span>::<span class="ident">close</span>(<span class="ident">fd</span>);
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">ConnectError</span>::<span class="ident">InvalidFd</span>);
}
}
} <span class="kw">else</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">socket_path</span> <span class="op">=</span> <span class="ident">env</span>::<span class="ident">var_os</span>(<span class="string">"XDG_RUNTIME_DIR"</span>)
.<span class="ident">map</span>(<span class="ident">Into</span>::<span class="op"><</span><span class="ident">PathBuf</span><span class="op">></span>::<span class="ident">into</span>)
.<span class="ident">ok_or</span>(<span class="ident">ConnectError</span>::<span class="ident">XdgRuntimeDirNotSet</span>)<span class="question-mark">?</span>;
<span class="ident">socket_path</span>.<span class="ident">push</span>(<span class="ident">env</span>::<span class="ident">var_os</span>(<span class="string">"WAYLAND_DISPLAY"</span>).<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="op">|</span> <span class="string">"wayland-0"</span>.<span class="ident">into</span>()));
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UnixStream</span>::<span class="ident">connect</span>(<span class="ident">socket_path</span>).<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ConnectError</span>::<span class="ident">NoCompositorListening</span>)<span class="question-mark">?</span>;
<span class="kw">unsafe</span> { <span class="ident">Display</span>::<span class="ident">from_fd</span>(<span class="ident">socket</span>.<span class="ident">into_raw_fd</span>()) }
}
}
<span class="doccomment">/// Attempt to connect to a wayland server socket with given name</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On success, you are given the `Display` object as well as the main `EventQueue` hosting</span>
<span class="doccomment">/// the `WlDisplay` wayland object.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This requires the `XDG_RUNTIME_DIR` variable to be properly set.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">connect_to_name</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">OsString</span><span class="op">></span><span class="op">></span>(<span class="ident">name</span>: <span class="ident">S</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(<span class="ident">Display</span>, <span class="ident">EventQueue</span>), <span class="ident">ConnectError</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">socket_path</span> <span class="op">=</span> <span class="ident">env</span>::<span class="ident">var_os</span>(<span class="string">"XDG_RUNTIME_DIR"</span>)
.<span class="ident">map</span>(<span class="ident">Into</span>::<span class="op"><</span><span class="ident">PathBuf</span><span class="op">></span>::<span class="ident">into</span>)
.<span class="ident">ok_or</span>(<span class="ident">ConnectError</span>::<span class="ident">XdgRuntimeDirNotSet</span>)<span class="question-mark">?</span>;
<span class="ident">socket_path</span>.<span class="ident">push</span>(<span class="ident">name</span>.<span class="ident">into</span>());
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UnixStream</span>::<span class="ident">connect</span>(<span class="ident">socket_path</span>).<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ConnectError</span>::<span class="ident">NoCompositorListening</span>)<span class="question-mark">?</span>;
<span class="kw">unsafe</span> { <span class="ident">Display</span>::<span class="ident">from_fd</span>(<span class="ident">socket</span>.<span class="ident">into_raw_fd</span>()) }
}
<span class="doccomment">/// Attempt to use an already connected unix socket on given FD to start a wayland connection</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On success, you are given the `Display` object as well as the main `EventQueue` hosting</span>
<span class="doccomment">/// the `WlDisplay` wayland object.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Will take ownership of the FD.</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_fd</span>(<span class="ident">fd</span>: <span class="ident">RawFd</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(<span class="ident">Display</span>, <span class="ident">EventQueue</span>), <span class="ident">ConnectError</span><span class="op">></span> {
<span class="kw">let</span> (<span class="ident">d_inner</span>, <span class="ident">evq_inner</span>) <span class="op">=</span> <span class="ident">DisplayInner</span>::<span class="ident">from_fd</span>(<span class="ident">fd</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>((<span class="ident">Display</span> { <span class="ident">inner</span>: <span class="ident">d_inner</span> }, <span class="ident">EventQueue</span>::<span class="ident">new</span>(<span class="ident">evq_inner</span>)))
}
<span class="doccomment">/// Non-blocking write to the server</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Outgoing messages to the server are buffered by the library for efficiency. This method</span>
<span class="doccomment">/// flushes the internal buffer to the server socket.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Will write as many pending requests as possible to the server socket. Never blocks: if not all</span>
<span class="doccomment">/// requests could be written, will return an io error `WouldBlock`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On success returns the number of written requests.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">flush</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">flush</span>()
}
<span class="doccomment">/// Create a new event queue associated with this wayland connection</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">create_event_queue</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">EventQueue</span> {
<span class="kw">let</span> <span class="ident">evq_inner</span> <span class="op">=</span> <span class="ident">DisplayInner</span>::<span class="ident">create_event_queue</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>);
<span class="ident">EventQueue</span>::<span class="ident">new</span>(<span class="ident">evq_inner</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">/// Create a Display and Event Queue from an external display</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This allows you to interface with an already-existing wayland connection,</span>
<span class="doccomment">/// for example provided by a GUI toolkit.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// To avoid interferences with the owner of the connection, wayland-client will</span>
<span class="doccomment">/// create a new event queue and register a wrapper of the `wl_display` to this queue,</span>
<span class="doccomment">/// then provide them to you. You can then use them as if they came from a direct</span>
<span class="doccomment">/// wayland connection.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that if you need to retrieve the actual `wl_display` pointer back (rather than</span>
<span class="doccomment">/// its wrapper), you must use the `get_display_ptr()` method.</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_external_display</span>(<span class="ident">display_ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">wl_display</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">Display</span>, <span class="ident">EventQueue</span>) {
<span class="kw">let</span> (<span class="ident">d_inner</span>, <span class="ident">evq_inner</span>) <span class="op">=</span> <span class="ident">DisplayInner</span>::<span class="ident">from_external</span>(<span class="ident">display_ptr</span>);
(<span class="ident">Display</span> { <span class="ident">inner</span>: <span class="ident">d_inner</span> }, <span class="ident">EventQueue</span>::<span class="ident">new</span>(<span class="ident">evq_inner</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">/// Retrieve the `wl_display` pointer</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If this `Display` was created from an external `wl_display`, its `c_ptr()` method will</span>
<span class="doccomment">/// return a wrapper to the actual display. While this is perfectly good as a `wl_proxy`</span>
<span class="doccomment">/// pointer, to send requests, this is not the actual `wl_display` and cannot be used as such.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method will give you the `wl_display`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_display_ptr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">wl_display</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">ptr</span>()
}
}
<span class="kw">impl</span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Display</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">Proxy</span><span class="op"><</span>::<span class="ident">protocol</span>::<span class="ident">wl_display</span>::<span class="ident">WlDisplay</span><span class="op">></span>;
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">Proxy</span><span class="op"><</span>::<span class="ident">protocol</span>::<span class="ident">wl_display</span>::<span class="ident">WlDisplay</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_proxy</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>