Files
phy/x11rb/wrapper/trait.ConnectionExt.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

69 lines
16 KiB
HTML

<!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="Extension trait that simplifies API use"><title>ConnectionExt in x11rb::wrapper - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="x11rb" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../x11rb/index.html">x11rb</a><span class="version">0.13.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Connection<wbr>Ext</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.change_property16" title="change_property16">change_property16</a></li><li><a href="#method.change_property32" title="change_property32">change_property32</a></li><li><a href="#method.change_property8" title="change_property8">change_property8</a></li><li><a href="#method.sync" title="sync">sync</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In x11rb::<wbr>wrapper</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">x11rb</a>::<wbr><a href="index.html">wrapper</a></span><h1>Trait <span class="trait">ConnectionExt</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/x11rb/wrapper.rs.html#8-101">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ConnectionExt: <a class="trait" href="../protocol/xproto/trait.ConnectionExt.html" title="trait x11rb::protocol::xproto::ConnectionExt">XProtoConnectionExt</a> {
// Provided methods
fn <a href="#method.change_property8" class="fn">change_property8</a>&lt;A, B&gt;(
&amp;self,
mode: <a class="struct" href="../protocol/xproto/struct.PropMode.html" title="struct x11rb::protocol::xproto::PropMode">PropMode</a>,
window: <a class="type" href="../protocol/xproto/type.Window.html" title="type x11rb::protocol::xproto::Window">Window</a>,
property: A,
type_: B,
data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../cookie/struct.VoidCookie.html" title="struct x11rb::cookie::VoidCookie">VoidCookie</a>&lt;'_, Self&gt;, <a class="enum" href="../errors/enum.ConnectionError.html" title="enum x11rb::errors::ConnectionError">ConnectionError</a>&gt;
<span class="where">where A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,
B: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;</span> { ... }
<span class="item-spacer"></span> fn <a href="#method.change_property16" class="fn">change_property16</a>&lt;A, B&gt;(
&amp;self,
mode: <a class="struct" href="../protocol/xproto/struct.PropMode.html" title="struct x11rb::protocol::xproto::PropMode">PropMode</a>,
window: <a class="type" href="../protocol/xproto/type.Window.html" title="type x11rb::protocol::xproto::Window">Window</a>,
property: A,
type_: B,
data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../cookie/struct.VoidCookie.html" title="struct x11rb::cookie::VoidCookie">VoidCookie</a>&lt;'_, Self&gt;, <a class="enum" href="../errors/enum.ConnectionError.html" title="enum x11rb::errors::ConnectionError">ConnectionError</a>&gt;
<span class="where">where A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,
B: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;</span> { ... }
<span class="item-spacer"></span> fn <a href="#method.change_property32" class="fn">change_property32</a>&lt;A, B&gt;(
&amp;self,
mode: <a class="struct" href="../protocol/xproto/struct.PropMode.html" title="struct x11rb::protocol::xproto::PropMode">PropMode</a>,
window: <a class="type" href="../protocol/xproto/type.Window.html" title="type x11rb::protocol::xproto::Window">Window</a>,
property: A,
type_: B,
data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../cookie/struct.VoidCookie.html" title="struct x11rb::cookie::VoidCookie">VoidCookie</a>&lt;'_, Self&gt;, <a class="enum" href="../errors/enum.ConnectionError.html" title="enum x11rb::errors::ConnectionError">ConnectionError</a>&gt;
<span class="where">where A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,
B: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;</span> { ... }
<span class="item-spacer"></span> fn <a href="#method.sync" class="fn">sync</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>, <a class="enum" href="../errors/enum.ReplyError.html" title="enum x11rb::errors::ReplyError">ReplyError</a>&gt; { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension trait that simplifies API use</p>
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.change_property8" class="method"><a class="src rightside" href="../../src/x11rb/wrapper.rs.html#10-31">Source</a><h4 class="code-header">fn <a href="#method.change_property8" class="fn">change_property8</a>&lt;A, B&gt;(
&amp;self,
mode: <a class="struct" href="../protocol/xproto/struct.PropMode.html" title="struct x11rb::protocol::xproto::PropMode">PropMode</a>,
window: <a class="type" href="../protocol/xproto/type.Window.html" title="type x11rb::protocol::xproto::Window">Window</a>,
property: A,
type_: B,
data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../cookie/struct.VoidCookie.html" title="struct x11rb::cookie::VoidCookie">VoidCookie</a>&lt;'_, Self&gt;, <a class="enum" href="../errors/enum.ConnectionError.html" title="enum x11rb::errors::ConnectionError">ConnectionError</a>&gt;<div class="where">where
A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,
B: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,</div></h4></section></summary><div class="docblock"><p>Change a property on a window with format 8.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.change_property16" class="method"><a class="src rightside" href="../../src/x11rb/wrapper.rs.html#34-59">Source</a><h4 class="code-header">fn <a href="#method.change_property16" class="fn">change_property16</a>&lt;A, B&gt;(
&amp;self,
mode: <a class="struct" href="../protocol/xproto/struct.PropMode.html" title="struct x11rb::protocol::xproto::PropMode">PropMode</a>,
window: <a class="type" href="../protocol/xproto/type.Window.html" title="type x11rb::protocol::xproto::Window">Window</a>,
property: A,
type_: B,
data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../cookie/struct.VoidCookie.html" title="struct x11rb::cookie::VoidCookie">VoidCookie</a>&lt;'_, Self&gt;, <a class="enum" href="../errors/enum.ConnectionError.html" title="enum x11rb::errors::ConnectionError">ConnectionError</a>&gt;<div class="where">where
A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,
B: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,</div></h4></section></summary><div class="docblock"><p>Change a property on a window with format 16.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.change_property32" class="method"><a class="src rightside" href="../../src/x11rb/wrapper.rs.html#62-87">Source</a><h4 class="code-header">fn <a href="#method.change_property32" class="fn">change_property32</a>&lt;A, B&gt;(
&amp;self,
mode: <a class="struct" href="../protocol/xproto/struct.PropMode.html" title="struct x11rb::protocol::xproto::PropMode">PropMode</a>,
window: <a class="type" href="../protocol/xproto/type.Window.html" title="type x11rb::protocol::xproto::Window">Window</a>,
property: A,
type_: B,
data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../cookie/struct.VoidCookie.html" title="struct x11rb::cookie::VoidCookie">VoidCookie</a>&lt;'_, Self&gt;, <a class="enum" href="../errors/enum.ConnectionError.html" title="enum x11rb::errors::ConnectionError">ConnectionError</a>&gt;<div class="where">where
A: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,
B: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../protocol/xproto/type.Atom.html" title="type x11rb::protocol::xproto::Atom">Atom</a>&gt;,</div></h4></section></summary><div class="docblock"><p>Change a property on a window with format 32.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.sync" class="method"><a class="src rightside" href="../../src/x11rb/wrapper.rs.html#94-100">Source</a><h4 class="code-header">fn <a href="#method.sync" class="fn">sync</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>, <a class="enum" href="../errors/enum.ReplyError.html" title="enum x11rb::errors::ReplyError">ReplyError</a>&gt;</h4></section></summary><div class="docblock"><p>Synchronise with the X11 server.</p>
<p>This function synchronises with the X11 server. This means that all requests that are still
in the output buffer are sent to the server. Then, we wait until the X11 server processed
all requests.</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ConnectionExt-for-C" class="impl"><a class="src rightside" href="../../src/x11rb/wrapper.rs.html#102">Source</a><a href="#impl-ConnectionExt-for-C" class="anchor">§</a><h3 class="code-header">impl&lt;C: <a class="trait" href="../protocol/xproto/trait.ConnectionExt.html" title="trait x11rb::protocol::xproto::ConnectionExt">XProtoConnectionExt</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="trait.ConnectionExt.html" title="trait x11rb::wrapper::ConnectionExt">ConnectionExt</a> for C</h3></section></div><script src="../../trait.impl/x11rb/wrapper/trait.ConnectionExt.js" async></script></section></div></main></body></html>