orion/phy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
doc
phy/polling/struct.Poller.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

189 lines
50 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Waits for I/O events."><title>Poller in polling - 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="polling" 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="icon" href="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png"></head><body class="rustdoc struct"><!--[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><a class="logo-container" href="../polling/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../polling/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt="logo"></a><h2><a href="../polling/index.html">polling</a><span class="version">3.7.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Poller</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.add" title="add">add</a></li><li><a href="#method.add_with_mode" title="add_with_mode">add_with_mode</a></li><li><a href="#method.delete" title="delete">delete</a></li><li><a href="#method.modify" title="modify">modify</a></li><li><a href="#method.modify_with_mode" title="modify_with_mode">modify_with_mode</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.notify" title="notify">notify</a></li><li><a href="#method.supports_edge" title="supports_edge">supports_edge</a></li><li><a href="#method.supports_level" title="supports_level">supports_level</a></li><li><a href="#method.wait" title="wait">wait</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-AsFd-for-Poller" title="AsFd">AsFd</a></li><li><a href="#impl-AsRawFd-for-Poller" title="AsRawFd">AsRawFd</a></li><li><a href="#impl-Debug-for-Poller" title="Debug">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Poller" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Poller" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Poller" title="Send">Send</a></li><li><a href="#impl-Sync-for-Poller" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Poller" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Poller" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-AsSource-for-T" title="AsSource">AsSource</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Instrument-for-T" title="Instrument">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li><li><a href="#impl-WithSubscriber-for-T" title="WithSubscriber">WithSubscriber</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate polling</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">polling</a></span><h1>Struct <span class="struct">Poller</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/polling/lib.rs.html#437-441">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Poller { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Waits for I/O events.</p>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Poller" class="impl"><a class="src rightside" href="../src/polling/lib.rs.html#443-804">Source</a><a href="#impl-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#454-460">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a>&gt;</h4></section></summary><div class="docblock"><p>Creates a new poller.</p>
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>polling::Poller;
<span class="kw">let </span>poller = Poller::new()<span class="question-mark">?</span>;</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.supports_level" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#463-465">Source</a><h4 class="code-header">pub fn <a href="#method.supports_level" class="fn">supports_level</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Tell whether or not this <code>Poller</code> supports level-triggered polling.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.supports_edge" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#468-470">Source</a><h4 class="code-header">pub fn <a href="#method.supports_edge" class="fn">supports_edge</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Tell whether or not this <code>Poller</code> supports edge-triggered polling.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.add" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#532-534">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.add" class="fn">add</a>(
&amp;self,
source: impl <a class="trait" href="trait.AsRawSource.html" title="trait polling::AsRawSource">AsRawSource</a>,
interest: <a class="struct" href="struct.Event.html" title="struct polling::Event">Event</a>,
) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Adds a file descriptor or socket to the poller.</p>
<p>A file descriptor or socket is considered readable or writable when a read or write
operation on it would not block. This doesn’t mean the read or write operation will
succeed, it only means the operation will return immediately.</p>
<p>If interest is set in both readability and writability, the two kinds of events might be
delivered either separately or together.</p>
<p>For example, interest in <code>Event { key: 7, readable: true, writable: true }</code> might result in
a single <a href="struct.Event.html" title="struct polling::Event"><code>Event</code></a> of the same form, or in two separate <a href="struct.Event.html" title="struct polling::Event"><code>Event</code></a>s:</p>
<ul>
<li><code>Event { key: 7, readable: true, writable: false }</code></li>
<li><code>Event { key: 7, readable: false, writable: true }</code></li>
</ul>
<p>Note that interest in I/O events needs to be re-enabled using
<a href="struct.Poller.html#method.modify" title="method polling::Poller::modify"><code>modify()</code></a> again after an event is delivered if we’re interested in
the next event of the same kind.</p>
<p>It is possible to register interest in the same file descriptor or socket using multiple
separate <a href="struct.Poller.html" title="struct polling::Poller"><code>Poller</code></a> instances. When the event is delivered, one or more <a href="struct.Poller.html" title="struct polling::Poller"><code>Poller</code></a>s are
notified with that event. The exact number of <a href="struct.Poller.html" title="struct polling::Poller"><code>Poller</code></a>s notified depends on the
underlying platform. When registering multiple sources into one event, the user should
be careful to accommodate for events lost to other pollers.</p>
<p>One may also register one source into other, non-<code>polling</code> event loops, like GLib’s
context. While the plumbing will vary from platform to platform, in general the <a href="struct.Poller.html" title="struct polling::Poller"><code>Poller</code></a>
will act as if the source was registered with another <a href="struct.Poller.html" title="struct polling::Poller"><code>Poller</code></a>, with the same caveats
as above.</p>
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<p>The source must be <a href="struct.Poller.html#method.delete" title="method polling::Poller::delete"><code>delete()</code></a>d from this <code>Poller</code> before it is dropped.</p>
<h5 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h5>
<p>This method returns an error in the following situations:</p>
<ul>
<li>If <code>key</code> equals <code>usize::MAX</code> because that key is reserved for internal use.</li>
<li>If an error is returned by the syscall.</li>
</ul>
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
<p>Set interest in all events:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>polling::{Event, Poller};
<span class="kw">let </span>source = std::net::TcpListener::bind(<span class="string">"127.0.0.1:0"</span>)<span class="question-mark">?</span>;
source.set_nonblocking(<span class="bool-val">true</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>key = <span class="number">7</span>;
<span class="kw">let </span>poller = Poller::new()<span class="question-mark">?</span>;
<span class="kw">unsafe </span>{
poller.add(<span class="kw-2">&amp;</span>source, Event::all(key))<span class="question-mark">?</span>;
}
poller.delete(<span class="kw-2">&amp;</span>source)<span class="question-mark">?</span>;</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_with_mode" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#551-564">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.add_with_mode" class="fn">add_with_mode</a>(
&amp;self,
source: impl <a class="trait" href="trait.AsRawSource.html" title="trait polling::AsRawSource">AsRawSource</a>,
interest: <a class="struct" href="struct.Event.html" title="struct polling::Event">Event</a>,
mode: <a class="enum" href="enum.PollMode.html" title="enum polling::PollMode">PollMode</a>,
) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Adds a file descriptor or socket to the poller in the specified mode.</p>
<p>This is identical to the <code>add()</code> function, but allows specifying the
polling mode to use for this socket.</p>
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
<p>The source must be <a href="struct.Poller.html#method.delete" title="method polling::Poller::delete"><code>delete()</code></a>d from this <code>Poller</code> before it is dropped.</p>
<h5 id="errors-1"><a class="doc-anchor" href="#errors-1">§</a>Errors</h5>
<p>If the operating system does not support the specified mode, this function
will return an error.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.modify" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#637-639">Source</a><h4 class="code-header">pub fn <a href="#method.modify" class="fn">modify</a>(&amp;self, source: impl <a class="trait" href="trait.AsSource.html" title="trait polling::AsSource">AsSource</a>, interest: <a class="struct" href="struct.Event.html" title="struct polling::Event">Event</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Modifies the interest in a file descriptor or socket.</p>
<p>This method has the same behavior as <a href="struct.Poller.html#method.add" title="method polling::Poller::add"><code>add()</code></a> except it modifies the
interest of a previously added file descriptor or socket.</p>
<p>To use this method with a file descriptor or socket, you must first add it using
<a href="struct.Poller.html#method.add" title="method polling::Poller::add"><code>add()</code></a>.</p>
<p>Note that interest in I/O events needs to be re-enabled using
<a href="struct.Poller.html#method.modify" title="method polling::Poller::modify"><code>modify()</code></a> again after an event is delivered if we’re interested in
the next event of the same kind.</p>
<h5 id="errors-2"><a class="doc-anchor" href="#errors-2">§</a>Errors</h5>
<p>This method returns an error in the following situations:</p>
<ul>
<li>If <code>key</code> equals <code>usize::MAX</code> because that key is reserved for internal use.</li>
<li>If an error is returned by the syscall.</li>
</ul>
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
<p>To enable interest in all events:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>poller.modify(<span class="kw-2">&amp;</span>source, Event::all(key))<span class="question-mark">?</span>;</code></pre></div>
<p>To enable interest in readable events and disable interest in writable events:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>poller.modify(<span class="kw-2">&amp;</span>source, Event::readable(key))<span class="question-mark">?</span>;</code></pre></div>
<p>To disable interest in readable events and enable interest in writable events:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>poller.modify(<span class="kw-2">&amp;</span>source, Event::writable(key))<span class="question-mark">?</span>;</code></pre></div>
<p>To disable interest in all events:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>poller.modify(<span class="kw-2">&amp;</span>source, Event::none(key))<span class="question-mark">?</span>;</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.modify_with_mode" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#656-669">Source</a><h4 class="code-header">pub fn <a href="#method.modify_with_mode" class="fn">modify_with_mode</a>(
&amp;self,
source: impl <a class="trait" href="trait.AsSource.html" title="trait polling::AsSource">AsSource</a>,
interest: <a class="struct" href="struct.Event.html" title="struct polling::Event">Event</a>,
mode: <a class="enum" href="enum.PollMode.html" title="enum polling::PollMode">PollMode</a>,
) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Modifies interest in a file descriptor or socket to the poller, but with the specified
mode.</p>
<p>This is identical to the <code>modify()</code> function, but allows specifying the polling mode
to use for this socket.</p>
<h5 id="performance-notes"><a class="doc-anchor" href="#performance-notes">§</a>Performance Notes</h5>
<p>This function can be used to change a source from one polling mode to another. However,
on some platforms, this switch can cause delays in the delivery of events.</p>
<h5 id="errors-3"><a class="doc-anchor" href="#errors-3">§</a>Errors</h5>
<p>If the operating system does not support the specified mode, this function will return
an error.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.delete" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#691-693">Source</a><h4 class="code-header">pub fn <a href="#method.delete" class="fn">delete</a>(&amp;self, source: impl <a class="trait" href="trait.AsSource.html" title="trait polling::AsSource">AsSource</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Removes a file descriptor or socket from the poller.</p>
<p>Unlike <a href="struct.Poller.html#method.add" title="method polling::Poller::add"><code>add()</code></a>, this method only removes the file descriptor or
socket from the poller without putting it back into blocking mode.</p>
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>polling::{Event, Poller};
<span class="kw">use </span>std::net::TcpListener;
<span class="kw">let </span>socket = TcpListener::bind(<span class="string">"127.0.0.1:0"</span>)<span class="question-mark">?</span>;
socket.set_nonblocking(<span class="bool-val">true</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>key = <span class="number">7</span>;
<span class="kw">let </span>poller = Poller::new()<span class="question-mark">?</span>;
<span class="kw">unsafe </span>{ poller.add(<span class="kw-2">&amp;</span>socket, Event::all(key))<span class="question-mark">?</span>; }
poller.delete(<span class="kw-2">&amp;</span>socket)<span class="question-mark">?</span>;</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.wait" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#734-767">Source</a><h4 class="code-header">pub fn <a href="#method.wait" class="fn">wait</a>(
&amp;self,
events: &amp;mut <a class="struct" href="struct.Events.html" title="struct polling::Events">Events</a>,
timeout: <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.84.0/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>&gt;,
) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>&gt;</h4></section></summary><div class="docblock"><p>Waits for at least one I/O event and returns the number of new events.</p>
<p>New events will be appended to <code>events</code>. If necessary, make sure to clear the
<a href="struct.Events.html#method.clear" title="method polling::Events::clear"><code>Events</code></a> before calling <a href="struct.Poller.html#method.wait" title="method polling::Poller::wait"><code>wait()</code></a>!</p>
<p>This method will return with no new events if a notification is delivered by the
<a href="struct.Poller.html#method.notify" title="method polling::Poller::notify"><code>notify()</code></a> method, or the timeout is reached. Sometimes it may even return with no events
spuriously.</p>
<p>Only one thread can wait on I/O. If another thread is already in <a href="struct.Poller.html#method.wait" title="method polling::Poller::wait"><code>wait()</code></a>, concurrent
calls to this method will return immediately with no new events.</p>
<p>If the operating system is ready to deliver a large number of events at once, this method
may decide to deliver them in smaller batches.</p>
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>polling::{Event, Events, Poller};
<span class="kw">use </span>std::net::TcpListener;
<span class="kw">use </span>std::time::Duration;
<span class="kw">let </span>socket = TcpListener::bind(<span class="string">"127.0.0.1:0"</span>)<span class="question-mark">?</span>;
socket.set_nonblocking(<span class="bool-val">true</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>key = <span class="number">7</span>;
<span class="kw">let </span>poller = Poller::new()<span class="question-mark">?</span>;
<span class="kw">unsafe </span>{
poller.add(<span class="kw-2">&amp;</span>socket, Event::all(key))<span class="question-mark">?</span>;
}
<span class="kw">let </span><span class="kw-2">mut </span>events = Events::new();
<span class="kw">let </span>n = poller.wait(<span class="kw-2">&amp;mut </span>events, <span class="prelude-val">Some</span>(Duration::from_secs(<span class="number">1</span>)))<span class="question-mark">?</span>;
poller.delete(<span class="kw-2">&amp;</span>socket)<span class="question-mark">?</span>;</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.notify" class="method"><a class="src rightside" href="../src/polling/lib.rs.html#791-803">Source</a><h4 class="code-header">pub fn <a href="#method.notify" class="fn">notify</a>(&amp;self) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Wakes up the current or the following invocation of <a href="struct.Poller.html#method.wait" title="method polling::Poller::wait"><code>wait()</code></a>.</p>
<p>If no thread is calling <a href="struct.Poller.html#method.wait" title="method polling::Poller::wait"><code>wait()</code></a> right now, this method will cause the following call
to wake up immediately.</p>
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>polling::{Events, Poller};
<span class="kw">let </span>poller = Poller::new()<span class="question-mark">?</span>;
<span class="comment">// Notify the poller.
</span>poller.notify()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>events = Events::new();
poller.wait(<span class="kw-2">&amp;mut </span>events, <span class="prelude-val">None</span>)<span class="question-mark">?</span>; <span class="comment">// wakes up immediately
</span><span class="macro">assert!</span>(events.is_empty());</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-AsFd-for-Poller" class="impl"><a class="src rightside" href="../src/polling/lib.rs.html#1009-1013">Source</a><a href="#impl-AsFd-for-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/std/os/fd/owned/trait.AsFd.html" title="trait std::os::fd::owned::AsFd">AsFd</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_fd" class="method trait-impl"><a class="src rightside" href="../src/polling/lib.rs.html#1010-1012">Source</a><a href="#method.as_fd" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/std/os/fd/owned/trait.AsFd.html#tymethod.as_fd" class="fn">as_fd</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/os/fd/owned/struct.BorrowedFd.html" title="struct std::os::fd::owned::BorrowedFd">BorrowedFd</a>&lt;'_&gt;</h4></section></summary><div class='docblock'>Borrows the file descriptor. <a href="https://doc.rust-lang.org/1.84.0/std/os/fd/owned/trait.AsFd.html#tymethod.as_fd">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsRawFd-for-Poller" class="impl"><a class="src rightside" href="../src/polling/lib.rs.html#1003-1007">Source</a><a href="#impl-AsRawFd-for-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/std/os/fd/raw/trait.AsRawFd.html" title="trait std::os::fd::raw::AsRawFd">AsRawFd</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_raw_fd" class="method trait-impl"><a class="src rightside" href="../src/polling/lib.rs.html#1004-1006">Source</a><a href="#method.as_raw_fd" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/std/os/fd/raw/trait.AsRawFd.html#tymethod.as_raw_fd" class="fn">as_raw_fd</a>(&amp;self) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/std/os/fd/raw/type.RawFd.html" title="type std::os::fd::raw::RawFd">RawFd</a></h4></section></summary><div class='docblock'>Extracts the raw file descriptor. <a href="https://doc.rust-lang.org/1.84.0/std/os/fd/raw/trait.AsRawFd.html#tymethod.as_raw_fd">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Poller" class="impl"><a class="src rightside" href="../src/polling/lib.rs.html#1035-1039">Source</a><a href="#impl-Debug-for-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/polling/lib.rs.html#1036-1038">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Poller" class="impl"><a href="#impl-Freeze-for-Poller" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section><section id="impl-RefUnwindSafe-for-Poller" class="impl"><a href="#impl-RefUnwindSafe-for-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section><section id="impl-Send-for-Poller" class="impl"><a href="#impl-Send-for-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section><section id="impl-Sync-for-Poller" class="impl"><a href="#impl-Sync-for-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section><section id="impl-Unpin-for-Poller" class="impl"><a href="#impl-Unpin-for-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section><section id="impl-UnwindSafe-for-Poller" class="impl"><a href="#impl-UnwindSafe-for-Poller" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Poller.html" title="struct polling::Poller">Poller</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsSource-for-T" class="impl"><a class="src rightside" href="../src/polling/lib.rs.html#1074">Source</a><a href="#impl-AsSource-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.AsSource.html" title="trait polling::AsSource">AsSource</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/std/os/fd/owned/trait.AsFd.html" title="trait std::os::fd::owned::AsFd">AsFd</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.source" class="method trait-impl"><a class="src rightside" href="../src/polling/lib.rs.html#1069-1071">Source</a><a href="#method.source" class="anchor">§</a><h4 class="code-header">fn <a href="trait.AsSource.html#method.source" class="fn">source</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/os/fd/owned/struct.BorrowedFd.html" title="struct std::os::fd::owned::BorrowedFd">BorrowedFd</a>&lt;'_&gt;</h4></section></summary><div class='docblock'>Returns the borrowed file descriptor.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-T" class="impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#325">Source</a><a href="#impl-Instrument-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#86">Source</a><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a href="../tracing/instrument/trait.Instrument.html#method.instrument" class="fn">instrument</a>(self, span: <a class="struct" href="../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -&gt; <a class="struct" href="../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="../tracing/span/struct.Span.html" title="struct tracing::span::Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#128">Source</a><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a href="../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fn">in_current_span</a>(self) -&gt; <a class="struct" href="../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the <a href="../tracing/span/struct.Span.html#method.current" title="associated function tracing::span::Span::current">current</a> <a href="../tracing/span/struct.Span.html" title="struct tracing::span::Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <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;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <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;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&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;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(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;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-T" class="impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#393">Source</a><a href="#impl-WithSubscriber-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../tracing/instrument/trait.WithSubscriber.html" title="trait tracing::instrument::WithSubscriber">WithSubscriber</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#176-178">Source</a><a href="#method.with_subscriber" class="anchor">§</a><h4 class="code-header">fn <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber" class="fn">with_subscriber</a>&lt;S&gt;(self, subscriber: S) -&gt; <a class="struct" href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a>&lt;Self&gt;<div class="where">where
S: <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="struct" href="../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>&gt;,</div></h4></section></summary><div class='docblock'>Attaches the provided <a href="../tracing_core/subscriber/trait.Subscriber.html" title="trait tracing_core::subscriber::Subscriber"><code>Subscriber</code></a> to this type, returning a
<a href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#228">Source</a><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fn">with_current_subscriber</a>(self) -&gt; <a class="struct" href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Attaches the current <a href="../tracing/dispatcher/index.html#setting-the-default-subscriber" title="mod tracing::dispatcher">default</a> <a href="../tracing_core/subscriber/trait.Subscriber.html" title="trait tracing_core::subscriber::Subscriber"><code>Subscriber</code></a> to this type, returning a
<a href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details></div></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink