mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'da836f318e'
${ noResults }
Trac3r-rust/doc/wayland_client/struct.Display.html

114 lines
41 KiB
Raw Normal View History Unescape

add doc
5 years ago
<!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 `Display` struct in crate `wayland_client`."><meta name="keywords" content="rust, rustlang, rust-lang, Display"><title>wayland_client::Display - 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 struct"><!--[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><a href='../wayland_client/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct Display</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.connect_to_env">connect_to_env</a><a href="#method.connect_to_name">connect_to_name</a><a href="#method.create_event_queue">create_event_queue</a><a href="#method.flush">flush</a><a href="#method.from_external_display">from_external_display</a><a href="#method.from_fd">from_fd</a><a href="#method.get_display_ptr">get_display_ptr</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref&lt;Target=Proxy&lt;WlDisplay&gt;&gt;</a><div class="sidebar-links"><a href="#method.anonymize">anonymize</a><a href="#method.c_ptr">c_ptr</a><a href="#method.child">child</a><a href="#method.child_placeholder">child_placeholder</a><a href="#method.equals">equals</a><a href="#method.id">id</a><a href="#method.is_alive">is_alive</a><a href="#method.is_external">is_external</a><a href="#method.make_wrapper">make_wrapper</a><a href="#method.send">send</a><a href="#method.send_constructor">send_constructor</a><a href="#method.user_data">user_data</a><a href="#method.version">version</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Deref">Deref</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow&lt;T&gt;</a><a href="#impl-BorrowMut%3CT%3E">BorrowMut&lt;T&gt;</a><a href="#impl-From%3CT%3E">From&lt;T&gt;</a><a href="#impl-Into%3CU%3E">Into&lt;U&gt;</a><a href="#impl-TryFrom%3CU%3E">TryFrom&lt;U&gt;</a><a href="#impl-TryInto%3CU%3E">TryInto&lt;U&gt;</a></div></div><p class='location'><a href='index.html'>wayland_client</a></p><script>window.sidebarCurrent = {name: 'Display', ty: 'struct', 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"></
<p>This object both represent the connection to the server, and as such
must be kept alive as long as you are connected, and contains the
primary <code>WlDisplay</code> wayland object, from which you can create all
your need objects. The inner <code>Proxy&lt;WlDisplay&gt;</code> can be accessed via
<code>Deref</code>.</p>
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/wayland_client/display.rs.html#67-186' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.connect_to_env' class="method"><code id='connect_to_env.v'>pub fn <a href='#method.connect_to_env' class='fnname'>connect_to_env</a>() -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a>, <a class="struct" href="../wayland_client/struct.EventQueue.html" title="struct wayland_client::EventQueue">EventQueue</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../wayland_client/enum.ConnectError.html" title="enum wayland_client::ConnectError">ConnectError</a>&gt;</code><a class='srclink' href='../src/wayland_client/display.rs.html#80-109' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempt to connect to a wayland server using the contents of the environment variables</p>
<p>First of all, if the <code>WAYLAND_SOCKET</code> environment variable is set, it'll try to interpret
it as a FD number to use</p>
<p>If the <code>WAYLAND_DISPLAY</code> variable is set, it will try to connect to the socket it points
to. Otherwise, it will default to <code>wayland-0</code>.</p>
<p>On success, you are given the <code>Display</code> object as well as the main <code>EventQueue</code> hosting
the <code>WlDisplay</code> wayland object.</p>
<p>This requires the <code>XDG_RUNTIME_DIR</code> variable to be properly set.</p>
</div><h4 id='method.connect_to_name' class="method"><code id='connect_to_name.v'>pub fn <a href='#method.connect_to_name' class='fnname'>connect_to_name</a>&lt;S:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>&gt;&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;name: S<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a>, <a class="struct" href="../wayland_client/struct.EventQueue.html" title="struct wayland_client::EventQueue">EventQueue</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../wayland_client/enum.ConnectError.html" title="enum wayland_client::ConnectError">ConnectError</a>&gt;</code><a class='srclink' href='../src/wayland_client/display.rs.html#117-125' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempt to connect to a wayland server socket with given name</p>
<p>On success, you are given the <code>Display</code> object as well as the main <code>EventQueue</code> hosting
the <code>WlDisplay</code> wayland object.</p>
<p>This requires the <code>XDG_RUNTIME_DIR</code> variable to be properly set.</p>
</div><h4 id='method.from_fd' class="method"><code id='from_fd.v'>pub unsafe fn <a href='#method.from_fd' class='fnname'>from_fd</a>(fd: <a class="type" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/type.RawFd.html" title="type std::sys::unix::ext::io::RawFd">RawFd</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a>, <a class="struct" href="../wayland_client/struct.EventQueue.html" title="struct wayland_client::EventQueue">EventQueue</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../wayland_client/enum.ConnectError.html" title="enum wayland_client::ConnectError">ConnectError</a>&gt;</code><a class='srclink' href='../src/wayland_client/display.rs.html#133-136' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempt to use an already connected unix socket on given FD to start a wayland connection</p>
<p>On success, you are given the <code>Display</code> object as well as the main <code>EventQueue</code> hosting
the <code>WlDisplay</code> wayland object.</p>
<p>Will take ownership of the FD.</p>
</div><h4 id='method.flush' class="method"><code id='flush.v'>pub fn <a href='#method.flush' class='fnname'>flush</a>(&amp;self) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code><a class='srclink' href='../src/wayland_client/display.rs.html#147-149' title='goto source code'>[src]</a></h4><div class='docblock'><p>Non-blocking write to the server</p>
<p>Outgoing messages to the server are buffered by the library for efficiency. This method
flushes the internal buffer to the server socket.</p>
<p>Will write as many pending requests as possible to the server socket. Never blocks: if not all
requests could be written, will return an io error <code>WouldBlock</code>.</p>
<p>On success returns the number of written requests.</p>
</div><h4 id='method.create_event_queue' class="method"><code id='create_event_queue.v'>pub fn <a href='#method.create_event_queue' class='fnname'>create_event_queue</a>(&amp;self) -&gt; <a class="struct" href="../wayland_client/struct.EventQueue.html" title="struct wayland_client::EventQueue">EventQueue</a></code><a class='srclink' href='../src/wayland_client/display.rs.html#152-155' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a new event queue associated with this wayland connection</p>
</div><h4 id='method.from_external_display' class="method"><code id='from_external_display.v'>pub unsafe fn <a href='#method.from_external_display' class='fnname'>from_external_display</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;display_ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../wayland_client/sys/client/enum.wl_display.html" title="enum wayland_client::sys::client::wl_display">wl_display</a><br>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a>, <a class="struct" href="../wayland_client/struct.EventQueue.html" title="struct wayland_client::EventQueue">EventQueue</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../src/wayland_client/display.rs.html#170-173' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a Display and Event Queue from an external display</p>
<p>This allows you to interface with an already-existing wayland connection,
for example provided by a GUI toolkit.</p>
<p>To avoid interferences with the owner of the connection, wayland-client will
create a new event queue and register a wrapper of the <code>wl_display</code> to this queue,
then provide them to you. You can then use them as if they came from a direct
wayland connection.</p>
<p>Note that if you need to retrieve the actual <code>wl_display</code> pointer back (rather than
its wrapper), you must use the <code>get_display_ptr()</code> method.</p>
</div><h4 id='method.get_display_ptr' class="method"><code id='get_display_ptr.v'>pub fn <a href='#method.get_display_ptr' class='fnname'>get_display_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../wayland_client/sys/client/enum.wl_display.html" title="enum wayland_client::sys::client::wl_display">wl_display</a></code><a class='srclink' href='../src/wayland_client/display.rs.html#183-185' title='goto source code'>[src]</a></h4><div class='docblock'><p>Retrieve the <code>wl_display</code> pointer</p>
<p>If this <code>Display</code> was created from an external <code>wl_display</code>, its <code>c_ptr()</code> method will
return a wrapper to the actual display. While this is perfectly good as a <code>wl_proxy</code>
pointer, to send requests, this is not the actual <code>wl_display</code> and cannot be used as such.</p>
<p>This method will give you the <code>wl_display</code>.</p>
</div></div><h2 id='deref-methods' class='small-section-header'>Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>&lt;Target = <a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;<a class="struct" href="../wayland_client/protocol/wl_display/struct.WlDisplay.html" title="struct wayland_client::protocol::wl_display::WlDisplay">WlDisplay</a>&gt;&gt;<a href='#deref-methods' class='anchor'></a></h2><div class='impl-items'><h4 id='method.send' class="method"><code id='send.v'>pub fn <a href='#method.send' class='fnname'>send</a>(&amp;self, msg: I::<a class="type" href="../wayland_client/trait.Interface.html#associatedtype.Request" title="type wayland_client::Interface::Request">Request</a>)</code><a class='srclink' href='../src/wayland_client/proxy.rs.html#65-67' title='goto source code'>[src]</a></h4><div class='docblock'><p>Send a request through this object</p>
<p><strong>Warning:</strong> This method is mostly intended to be used by code generated
by <code>wayland-scanner</code>, and you should probably never need to use it directly,
but rather use the appropriate <code>RequestsTrait</code> for your proxy.</p>
<p>This is the generic method to send requests.</p>
<p>If your request needs to create an object, use <code>send_constructor</code>.</p>
</div><h4 id='method.send_constructor' class="method"><code id='send_constructor.v'>pub fn <a href='#method.send_constructor' class='fnname'>send_constructor</a>&lt;J, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;msg: I::<a class="type" href="../wayland_client/trait.Interface.html#associatedtype.Request" title="type wayland_client::Interface::Request">Request</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;implementor: F, <br>&nbsp;&nbsp;&nbsp;&nbsp;version: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;J&gt;, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;J: <a class="trait" href="../wayland_client/trait.Interface.html" title="trait wayland_client::Interface">Interface</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="../wayland_client/struct.NewProxy.html" title="struct wayland_client::NewProxy">NewProxy</a>&lt;J&gt;) -&gt; <a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;J&gt;,&nbsp;</span></code><a class='srclink' href='../src/wayland_client/proxy.rs.html#79-93' title='goto source code'>[src]</a></h4><div class='docblock'><p>Send a request creating an object through this object</p>
<p><strong>Warning:</strong> This method is mostly intended to be used by code generated
by <code>wayland-scanner</code>, and you should probably never need to use it directly,
but rather use the appropriate <code>RequestsTrait</code> for your proxy.</p>
<p>This is the generic method to send requests that create objects</p>
<p>The slot in the message corresponding with the newly created object must have
been filled by a placeholder object (see <code>child_placeholder</code>).</p>
</div><h4 id='method.is_alive' class="method"><code id='is_alive.v'>pub fn <a href='#method.is_alive' class='fnname'>is_alive</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/wayland_client/proxy.rs.html#101-103' title='goto source code'>[src]</a></h4><div class='docblock'><p>Check if the object associated with this proxy is still alive</p>
<p>Will return <code>false</code> if the object has been destroyed.</p>
<p>If the object is not managed by this library, this will always
returns <code>true</code>.</p>
</div><h4 id='method.version' class="method"><code id='version.v'>pub fn <a href='#method.version' class='fnname'>version</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../src/wayland_client/proxy.rs.html#108-110' title='goto source code'>[src]</a></h4><div class='docblock'><p>Retrieve the interface version of this wayland object instance</p>
<p>Returns 0 on dead objects</p>
</div><h4 id='method.id' class="method"><code id='id.v'>pub fn <a href='#method.id' class='fnname'>id</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../src/wayland_client/proxy.rs.html#113-115' title='goto source code'>[src]</a></h4><div class='docblock'><p>Retrieve the object id of this wayland object</p>
</div><h4 id='method.user_data' class="method"><code id='user_data.v'>pub fn <a href='#method.user_data' class='fnname'>user_data</a>&lt;UD:&nbsp;'static&gt;(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>UD&gt;</code><a class='srclink' href='../src/wayland_client/proxy.rs.html#127-129' title='goto source code'>[src]</a></h4><div class='docblock'><p>Access the arbitrary payload associated to this object</p>
<p>You need to specify the expected type of this payload, and this
function will return <code>None</code> if either the types don't match or
you are attempting to access a non <code>Send + Sync</code> user data from the
wrong thread.</p>
<p>This value is associated to the Proxy when you implement it, and you
cannot access it mutably afterwards. If you need interior mutability,
you are responsible for using a <code>Mutex</code> or similar type to achieve it.</p>
</div><h4 id='method.equals' class="method"><code id='equals.v'>pub fn <a href='#method.equals' class='fnname'>equals</a>(&amp;self, other: &amp;<a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;I&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/wayland_client/proxy.rs.html#132-134' title='goto source code'>[src]</a></h4><div class='docblock'><p>Check if the other proxy refers to the same underlying wayland object</p>
</div><h4 id='method.child' class="method"><code id='child.v'>pub fn <a href='#method.child' class='fnname'>child</a>&lt;C:&nbsp;<a class="trait" href="../wayland_client/trait.Interface.html" title="trait wayland_client::Interface">Interface</a>&gt;(&amp;self) -&gt; <a class="struct" href="../wayland_client/struct.NewProxy.html" title="struct wayland_client::NewProxy">NewProxy</a>&lt;C&gt;</code><a class='srclink' href='../src/wayland_client/proxy.rs.html#150-155' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a new child object</p>
<p><strong>Warning:</strong> This method is mostly intended to be used by code generated
by <code>wayland-scanner</code>, and you should probably never need to use it directly,
but rather use the appropriate <code>RequestsTrait</code> for your proxy.</p>
<p>This creates a new wayland object, considered as a
child of this object. It will notably inherit its interface
version.</p>
<p>The created object should immediately be implemented and sent
in a request to the server, to keep the object list properly
synchronized. Failure to do so will likely cause a protocol
error.</p>
</div><h4 id='method.anonymize' class="method"><code id='anonymize.v'>pub fn <a href='#method.anonymize' class='fnname'>anonymize</a>(&amp;self) -&gt; <a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;<a class="struct" href="../wayland_client/struct.AnonymousObject.html" title="struct wayland_client::AnonymousObject">AnonymousObject</a>&gt;</code><a class='srclink' href='../src/wayland_client/proxy.rs.html#158-163' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a handle of this proxy with its actual type erased</p>
</div><h4 id='method.make_wrapper' class="method"><code id='make_wrapper.v'>pub fn <a href='#method.make_wrapper' class='fnname'>make_wrapper</a>(&amp;self, queue: &amp;<a class="struct" href="../wayland_client/struct.QueueToken.html" title="struct wayland_client::QueueToken">QueueToken</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;I&gt;, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code><a class='srclink' href='../src/wayland_client/proxy.rs.html#175-182' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a wrapper for this object for queue management</p>
<p>As assigning a proxy to an event queue can be a racy operation
in contexts involving multiple thread, this provides a facility
to do this safely.</p>
<p>The wrapper object created behaves like a regular <code>Proxy</code>, except that
all objects created as the result of its requests will be assigned to
the queue associated to the provided token, rather than the queue of
their parent. This does not change the queue of the proxy itself.</p>
</div><h4 id='method.child_placeholder' class="method"><code id='child_placeholder.v'>pub fn <a href='#method.child_placeholder' class='fnname'>child_placeholder</a>&lt;J:&nbsp;<a class="trait" href="../wayland_client/trait.Interface.html" title="trait wayland_client::Interface">Interface</a>&gt;(&amp;self) -&gt; <a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;J&gt;</code><a class='srclink' href='../src/wayland_client/proxy.rs.html#189-191' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a placeholder object, to be used with <code>send_constructor</code></p>
<p><strong>Warning:</strong> This method is mostly intended to be used by code generated
by <code>wayland-scanner</code>, and you should probably never need to use it directly,
but rather use the appropriate <code>RequestsTrait</code> for your proxy.</p>
</div></div><div class='impl-items'><h4 id='method.is_external' class="method"><code id='is_external.v'>pub fn <a href='#method.is_external' class='fnname'>is_external</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/wayland_client/proxy.rs.html#199-201' title='goto source code'>[src]</a></h4><div class='docblock'><p>Check whether this proxy is managed by the library or not</p>
<p>See <code>from_c_ptr</code> for details.</p>
</div><h4 id='method.c_ptr' class="method"><code id='c_ptr.v'>pub fn <a href='#method.c_ptr' class='fnname'>c_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../wayland_client/sys/client/enum.wl_proxy.html" title="enum wayland_client::sys::client::wl_proxy">wl_proxy</a></code><a class='srclink' href='../src/wayland_client/proxy.rs.html#208-210' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get a raw pointer to the underlying wayland object</p>
<p>Retrieve a pointer to the object from the <code>libwayland-client.so</code> library.
You will mostly need it to interface with C libraries needing access
to wayland objects (to initialize an opengl context for example).</p>
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Deref' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a></code><a href='#impl-Deref' class='anchor'></a><a class='srclink' href='../src/wayland_client/display.rs.html#188-193' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Target' class="type"><code id='Target.t'>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;<a class="struct" href="../wayland_client/protocol/wl_display/struct.WlDisplay.html" title="struct wayland_client::protocol::wl_display::WlDisplay">WlDisplay</a>&gt;</code></h4><div class='docblock'><p>The resulting type after dereferencing.</p>
</div><h4 id='method.deref' class="method hidden"><code id='deref.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&amp;self) -&gt; &amp;<a class="struct" href="../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a>&lt;<a class="struct" href="../wayland_client/protocol/wl_display/struct.WlDisplay.html" title="struct wayland_client::protocol::wl_display::WlDisplay">WlDisplay</a>&gt;</code><a class='srclink' href='../src/wayland_client/display.rs.html#190-192' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Dereferences the value.</p>
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../wayland_client/struct.Display.html" title="struct wayland_client::Display">Display</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -&gt; U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -&gt; T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div></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>&#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_client";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>