|
|
|
|
|
<!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 `MessageGroup` trait in crate `wayland_commons`."><meta name="keywords" content="rust, rustlang, rust-lang, MessageGroup"><title>wayland_commons::MessageGroup - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../wayland_commons/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait MessageGroup</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Map">Map</a></div><a class="sidebar-title" href="#associated-const">Associated Constants</a><div class="sidebar-links"><a href="#associatedconstant.MESSAGES">MESSAGES</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.as_raw_c_in">as_raw_c_in</a><a href="#tymethod.child">child</a><a href="#tymethod.from_raw">from_raw</a><a href="#tymethod.from_raw_c">from_raw_c</a><a href="#tymethod.into_raw">into_raw</a><a href="#tymethod.is_destructor">is_destructor</a><a href="#tymethod.opcode">opcode</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>wayland_commons</a></p><script>window.sidebarCurrent = {name: 'MessageGroup', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/wayland_commons/lib.rs.html#39-73' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>wayland_commons</a>::<wbr><a class="trait" href=''>MessageGroup</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait MessageGroup: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
|
|
|
type <a href='#associatedtype.Map' class="type">Map</a>;
|
|
|
|
|
|
|
|
|
|
|
|
const <a href='#associatedconstant.MESSAGES' class="constant"><b>MESSAGES</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a><a class="struct" href="../wayland_commons/wire/struct.MessageDesc.html" title="struct wayland_commons::wire::MessageDesc">MessageDesc</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#tymethod.opcode' class='fnname'>opcode</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.is_destructor' class='fnname'>is_destructor</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.child' class='fnname'>child</a><Meta: <a class="trait" href="../wayland_commons/map/trait.ObjectMetadata.html" title="trait wayland_commons::map::ObjectMetadata">ObjectMetadata</a>>(<br> opcode: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, <br> version: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> meta: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Meta<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../wayland_commons/map/struct.Object.html" title="struct wayland_commons::map::Object">Object</a><Meta>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.from_raw' class='fnname'>from_raw</a>(msg: <a class="struct" href="../wayland_commons/wire/struct.Message.html" title="struct wayland_commons::wire::Message">Message</a>, map: &mut Self::<a class="type" href="../wayland_commons/trait.MessageGroup.html#associatedtype.Map" title="type wayland_commons::MessageGroup::Map">Map</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.into_raw' class='fnname'>into_raw</a>(self, send_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../wayland_commons/wire/struct.Message.html" title="struct wayland_commons::wire::Message">Message</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> unsafe fn <a href='#tymethod.from_raw_c' class='fnname'>from_raw_c</a>(<br> obj: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>, <br> opcode: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> args: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="union" href="../wayland_sys/common/union.wl_argument.html" title="union wayland_sys::common::wl_argument">wl_argument</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.as_raw_c_in' class='fnname'>as_raw_c_in</a><F, T>(self, f: F) -> T<br> <span class="where">where<br> 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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="union" href="../wayland_sys/common/union.wl_argument.html" title="union wayland_sys::common::wl_argument">wl_argument</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> T</span>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>A group of messages</p>
|
|
|
|
|
|
<p>This represents a group of message that can be serialized on the protocol wire.
|
|
|
|
|
|
Typically the set of events or requests of a single interface.</p>
|
|
|
|
|
|
<p>Implementations of this trait are supposed to be
|
|
|
|
|
|
generated using the <code>wayland-scanner</code> crate.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Map' class='method'><code id='Map.t'>type <a href='#associatedtype.Map' class="type">Map</a></code></h3><div class='docblock'><p>The wrapper type for ObjectMap allowing the mapping of Object and
|
|
|
|
|
|
NewId arguments to the object map during parsing.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='associated-const' class='small-section-header'>Associated Constants<a href='#associated-const' class='anchor'></a></h2><div class='methods'><h3 id='associatedconstant.MESSAGES' class='method'><code id='MESSAGES.v'>const <a href='#associatedconstant.MESSAGES' class="constant"><b>MESSAGES</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a><a class="struct" href="../wayland_commons/wire/struct.MessageDesc.html" title="struct wayland_commons::wire::MessageDesc">MessageDesc</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></h3><div class='docblock'><p>Wire representation of this MessageGroup</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.opcode' class='method'><code id='opcode.v'>fn <a href='#tymethod.opcode' class='fnname'>opcode</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code></h3><div class='docblock'><p>The opcode of this message</p>
|
|
|
|
|
|
</div><h3 id='tymethod.is_destructor' class='method'><code id='is_destructor.v'>fn <a href='#tymethod.is_destructor' class='fnname'>is_destructor</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Whether this message is a destructor</p>
|
|
|
|
|
|
<p>If it is, once send or receive the associated object cannot be used any more.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.child' class='method'><code id='child.v'>fn <a href='#tymethod.child' class='fnname'>child</a><Meta: <a class="trait" href="../wayland_commons/map/trait.ObjectMetadata.html" title="trait wayland_commons::map::ObjectMetadata">ObjectMetadata</a>>(<br> opcode: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, <br> version: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> meta: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Meta<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../wayland_commons/map/struct.Object.html" title="struct wayland_commons::map::Object">Object</a><Meta>></code></h3><div class='docblock'><p>Retrieve the child <code>Object</code> associated with this message if any</p>
|
|
|
|
|
|
</div><h3 id='tymethod.from_raw' class='method'><code id='from_raw.v'>fn <a href='#tymethod.from_raw' class='fnname'>from_raw</a>(msg: <a class="struct" href="../wayland_commons/wire/struct.Message.html" title="struct wayland_commons::wire::Message">Message</a>, map: &mut Self::<a class="type" href="../wayland_commons/trait.MessageGroup.html#associatedtype.Map" title="type wayland_commons::MessageGroup::Map">Map</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></h3><div class='docblock'><p>Construct a message from its raw representation</p>
|
|
|
|
|
|
</div><h3 id='tymethod.into_raw' class='method'><code id='into_raw.v'>fn <a href='#tymethod.into_raw' class='fnname'>into_raw</a>(self, send_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../wayland_commons/wire/struct.Message.html" title="struct wayland_commons::wire::Message">Message</a></code></h3><div class='docblock'><p>Turn this message into its raw representation</p>
|
|
|
|
|
|
</div><h3 id='tymethod.from_raw_c' class='method'><code id='from_raw_c.v'>unsafe fn <a href='#tymethod.from_raw_c' class='fnname'>from_raw_c</a>(<br> obj: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>, <br> opcode: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> args: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="union" href="../wayland_sys/common/union.wl_argument.html" title="union wayland_sys::common::wl_argument">wl_argument</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></h3><div class='docblock'><p>Construct a message of this group from its C representation</p>
|
|
|
|
|
|
</div><h3 id='tymethod.as_raw_c_in' class='method'><code id='as_raw_c_in.v'>fn <a href='#tymethod.as_raw_c_in' class='fnname'>as_raw_c_in</a><F, T>(self, f: F) -> T <span class="where fmt-newline">where<br> 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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="union" href="../wayland_sys/common/union.wl_argument.html" title="union wayland_sys::common::wl_argument">wl_argument</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> T, </span></code></h3><div class='docblock'><p>Build a C representation of this message</p>
|
|
|
|
|
|
<p>It can only be accessed from the provided closure, and this consumes
|
|
|
|
|
|
the message.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-MessageGroup' class='impl'><code class='in-band'>impl MessageGroup for <a class="enum" href="../wayland_commons/enum.NoMessage.html" title="enum wayland_commons::NoMessage">NoMessage</a></code><a href='#impl-MessageGroup' class='anchor'></a><a class='srclink' href='../src/wayland_commons/lib.rs.html#118-151' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedconstant.MESSAGES-1' class="associatedconstant hidden"><code id='MESSAGES.v-1'>const <a href='#associatedconstant.MESSAGES-1' class="constant"><b>MESSAGES</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a><a class="struct" href="../wayland_commons/wire/struct.MessageDesc.html" title="struct wayland_commons::wire::MessageDesc">MessageDesc</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../src/wayland_commons/lib.rs.html#119' title='goto source code'>[src]</a></h4><h4 id='associatedtype.Map-1' class="type"><code id='Map.t-1'>type <a href='#associatedtype.Map-1' class="type">Map</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></h4><h4 id='method.is_destructor' class="method hidden"><code id='is_destructor.v-1'>fn <a href='#method.is_destructor' class='fnname'>is_destructor</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/wayland_commons/lib.rs.html#121-123' title='goto source code'>[src]</a></h4><h4 id='method.opcode' class="method hidden"><code id='opcode.v-1'>fn <a href='#method.opcode' class='fnname'>opcode</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a class='srclink' href='../src/wayland_commons/lib.rs.html#124-126' title='goto source code'>[src]</a></h4><h4 id='method.child' class="method hidden"><code id='child.v-1'>fn <a href='#method.child' class='fnname'>child</a><M: <a class="trait" href="../wayland_commons/map/trait.ObjectMetadata.html" title="trait wayland_commons::map::ObjectMetadata">ObjectMetadata</a>>(_: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>M) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../wayland_commons/map/struct.Object.html" title="struct wayland_commons::map::Object">Object</a><M>></code><a class='srclink' href='../src/wayland_commons/lib.rs.html#127-129' title='goto source code'>[src]</a></h4><h4 id='method.from_raw' class="method hidden"><code id='from_raw.v-1'>fn <a href='#method.from_raw' class='fnname'>from_raw</a>(_: <a class="struct" href="../wayland_commons/wire/struct.Message.html" title="struct wayland_commons::wire::Message">Message</a>, _: &mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class='srclink' href='../src/wayland_commons/lib.rs.html#130-132' title='goto source code'>[src]</a></h4><h4 id='method.into_raw' class="method hidden"><code id='into_raw.v-1'>fn <a href='#method.into_raw' class='fnname'>into_raw</a>(self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../wayland_common
|
|
|
|
|
|
src="../implementors/wayland_commons/trait.MessageGroup.js">
|
|
|
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "wayland_commons";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
