pnmixer-rust/alsa/poll/trait.PollDescriptors.html

137 lines
10 KiB
HTML
Raw Normal View History

2017-07-14 23:30:16 +00:00
<!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 `PollDescriptors` trait in crate `alsa`.">
<meta name="keywords" content="rust, rustlang, rust-lang, PollDescriptors">
<title>alsa::poll::PollDescriptors - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</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">
<p class='location'>Trait PollDescriptors</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#provided-methods">Provided Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>alsa</a>::<wbr><a href='index.html'>poll</a></p><script>window.sidebarCurrent = {name: 'PollDescriptors', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>alsa</a>::<wbr><a href='index.html'>poll</a>::<wbr><a class="trait" href=''>PollDescriptors</a></span><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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/alsa/poll.rs.html#22-33' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait PollDescriptors {
fn <a href='#tymethod.count' class='fnname'>count</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
fn <a href='#tymethod.fill' class='fnname'>fill</a>(&amp;self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [</a><a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;;
fn <a href='#tymethod.revents' class='fnname'>revents</a>(&amp;self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="../../alsa/poll/struct.PollFlags.html" title="struct alsa::poll::PollFlags">PollFlags</a>&gt;;
fn <a href='#method.get' class='fnname'>get</a>(&amp;self) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a>&gt;&gt; { ... }
}</pre>
<h2 id='required-methods'>Required Methods</h2>
<div class='methods'>
<h3 id='tymethod.count' class='method'><span id='count.v' class='invisible'><code>fn <a href='#tymethod.count' class='fnname'>count</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h3><h3 id='tymethod.fill' class='method'><span id='fill.v' class='invisible'><code>fn <a href='#tymethod.fill' class='fnname'>fill</a>(&amp;self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [</a><a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></h3><h3 id='tymethod.revents' class='method'><span id='revents.v' class='invisible'><code>fn <a href='#tymethod.revents' class='fnname'>revents</a>(&amp;self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="../../alsa/poll/struct.PollFlags.html" title="struct alsa::poll::PollFlags">PollFlags</a>&gt;</code></span></h3></div>
<h2 id='provided-methods'>Provided Methods</h2>
<div class='methods'>
<h3 id='method.get' class='method'><span id='get.v' class='invisible'><code>fn <a href='#method.get' class='fnname'>get</a>(&amp;self) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a>&gt;&gt;</code></span></h3><div class='docblock'><p>Wrapper around count and fill - returns an array of pollfds</p>
</div></div>
<h2 id='implementors'>Implementors</h2>
<ul class='item-list' id='implementors-list'>
<li><code>impl PollDescriptors for <a class="struct" href="../../alsa/struct.Ctl.html" title="struct alsa::Ctl">Ctl</a></code></li>
<li><code>impl PollDescriptors for <a class="struct" href="../../alsa/hctl/struct.HCtl.html" title="struct alsa::hctl::HCtl">HCtl</a></code></li>
<li><code>impl PollDescriptors for <a class="struct" href="../../alsa/pcm/struct.PCM.html" title="struct alsa::pcm::PCM">PCM</a></code></li>
<li><code>impl PollDescriptors for <a class="struct" href="../../alsa/rawmidi/struct.Rawmidi.html" title="struct alsa::rawmidi::Rawmidi">Rawmidi</a></code></li>
<li><code>impl PollDescriptors for <a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a></code></li>
<li><code>impl PollDescriptors for <a class="struct" href="../../alsa/mixer/struct.Mixer.html" title="struct alsa::mixer::Mixer">Mixer</a></code></li>
<li><code>impl&lt;'a&gt; PollDescriptors for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&amp;'a <a class="struct" href="../../alsa/seq/struct.Seq.html" title="struct alsa::seq::Seq">Seq</a>, <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="enum" href="../../alsa/enum.Direction.html" title="enum alsa::Direction">Direction</a>&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></li>
</ul><script type="text/javascript" async
src="../../implementors/alsa/poll/trait.PollDescriptors.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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "alsa";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>