|
|
<!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="The main structure of the module, representing interest in some signals."><title>SignalsInfo in signal_hook::iterator - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="signal_hook" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../signal_hook/index.html">signal_hook</a><span class="version">0.3.17</span></h2></div><h2 class="location"><a href="#">SignalsInfo</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.add_signal">add_signal</a></li><li><a href="#method.forever">forever</a></li><li><a href="#method.handle">handle</a></li><li><a href="#method.is_closed">is_closed</a></li><li><a href="#method.new">new</a></li><li><a href="#method.pending">pending</a></li><li><a href="#method.wait">wait</a></li><li><a href="#method.with_exfiltrator">with_exfiltrator</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-SignalsInfo%3CE%3E">Debug</a></li><li><a href="#impl-IntoIterator-for-%26mut+SignalsInfo%3CE%3E">IntoIterator</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-SignalsInfo%3CE%3E">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-SignalsInfo%3CE%3E">!UnwindSafe</a></li><li><a href="#impl-Send-for-SignalsInfo%3CE%3E">Send</a></li><li><a href="#impl-Sync-for-SignalsInfo%3CE%3E">Sync</a></li><li><a href="#impl-Unpin-for-SignalsInfo%3CE%3E">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In signal_hook::iterator</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../signal_hook/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">signal_hook</a>::<wbr><a href="index.html">iterator</a>::<wbr><a class="struct" href="#">SignalsInfo</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/signal_hook/iterator/mod.rs.html#129">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct SignalsInfo<E: <a class="trait" href="exfiltrator/trait.Exfiltrator.html" title="trait signal_hook::iterator::exfiltrator::Exfiltrator">Exfiltrator</a> = <a class="struct" href="exfiltrator/struct.SignalOnly.html" title="struct signal_hook::iterator::exfiltrator::SignalOnly">SignalOnly</a>>(<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>The main structure of the module, representing interest in some signals.</p>
|
|
|
<p>Unlike the helpers in other modules, this registers the signals when created and unregisters
|
|
|
them on drop. It provides the pending signals during its lifetime, either in batches or as an
|
|
|
infinite iterator.</p>
|
|
|
<p>Most users will want to use it through the <a href="type.Signals.html" title="type signal_hook::iterator::Signals"><code>Signals</code></a> type alias for simplicity.</p>
|
|
|
<h2 id="multiple-threads"><a href="#multiple-threads">Multiple threads</a></h2>
|
|
|
<p>Instances of this struct can be <a href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">sent</a> to other threads. In a multithreaded
|
|
|
application this can be used to dedicate a separate thread for signal handling. In this case
|
|
|
you should get a <a href="backend/struct.Handle.html" title="struct signal_hook::iterator::backend::Handle"><code>Handle</code></a> using the <a href="struct.SignalsInfo.html#method.handle" title="method signal_hook::iterator::SignalsInfo::handle"><code>handle</code></a> method before sending the
|
|
|
<code>Signals</code> instance to a background thread. With the handle you will be able to shut down the
|
|
|
background thread later, or to operatively add more signals.</p>
|
|
|
<p>The controller handle can be shared between as many threads as you like using its
|
|
|
<a href="backend/struct.Handle.html#method.clone" title="method signal_hook::iterator::backend::Handle::clone"><code>clone</code></a> method.</p>
|
|
|
<h2 id="exfiltrators"><a href="#exfiltrators">Exfiltrators</a></h2>
|
|
|
<p>The [<code>SignalOnly]</code> provides only the signal number. There are further exfiltrators available in
|
|
|
the <a href="exfiltrator/index.html" title="mod signal_hook::iterator::exfiltrator"><code>exfiltrator</code></a> module. Note that some of them are behind feature flags that need to be
|
|
|
enabled.</p>
|
|
|
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>signal_hook::consts::signal::<span class="kw-2">*</span>;
|
|
|
<span class="kw">use </span>signal_hook::iterator::Signals;
|
|
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>signals = Signals::new(<span class="kw-2">&</span>[SIGUSR1, SIGUSR2])<span class="question-mark">?</span>;
|
|
|
<span class="kw">let </span>handle = signals.handle();
|
|
|
<span class="kw">let </span>thread = thread::spawn(<span class="kw">move </span>|| {
|
|
|
<span class="kw">for </span>signal <span class="kw">in </span><span class="kw-2">&mut </span>signals {
|
|
|
<span class="kw">match </span>signal {
|
|
|
SIGUSR1 => {},
|
|
|
SIGUSR2 => {},
|
|
|
<span class="kw">_ </span>=> <span class="macro">unreachable!</span>(),
|
|
|
}
|
|
|
}
|
|
|
});
|
|
|
|
|
|
<span class="comment">// Some time later...
|
|
|
</span>handle.close();
|
|
|
thread.join().unwrap();</code></pre></div>
|
|
|
</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-SignalsInfo%3CE%3E" class="impl"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#131-278">source</a><a href="#impl-SignalsInfo%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<E: <a class="trait" href="exfiltrator/trait.Exfiltrator.html" title="trait signal_hook::iterator::exfiltrator::Exfiltrator">Exfiltrator</a>> <a class="struct" href="struct.SignalsInfo.html" title="struct signal_hook::iterator::SignalsInfo">SignalsInfo</a><E></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/signal_hook/iterator/mod.rs.html#136-143">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a><I, S>(signals: I) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>><div class="where">where
|
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = S>,
|
|
|
S: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><<a class="type" href="../../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>>,
|
|
|
E: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h4></section></summary><div class="docblock"><p>Creates the <code>Signals</code> structure.</p>
|
|
|
<p>This registers all the signals listed. The same restrictions (panics, errors) apply as
|
|
|
for the <a href="backend/struct.Handle.html#method.add_signal" title="method signal_hook::iterator::backend::Handle::add_signal"><code>Handle::add_signal</code></a> method.</p>
|
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_exfiltrator" class="method"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#146-158">source</a><h4 class="code-header">pub fn <a href="#method.with_exfiltrator" class="fn">with_exfiltrator</a><I, S>(signals: I, exfiltrator: E) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>><div class="where">where
|
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = S>,
|
|
|
S: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><<a class="type" href="../../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>>,</div></h4></section></summary><div class="docblock"><p>An advanced constructor with explicit <a href="exfiltrator/trait.Exfiltrator.html" title="trait signal_hook::iterator::exfiltrator::Exfiltrator"><code>Exfiltrator</code></a>.</p>
|
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_signal" class="method"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#164-166">source</a><h4 class="code-header">pub fn <a href="#method.add_signal" class="fn">add_signal</a>(&self, signal: <a class="type" href="../../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Registers another signal to the set watched by this <a href="type.Signals.html" title="type signal_hook::iterator::Signals"><code>Signals</code></a> instance.</p>
|
|
|
<p>The same restrictions (panics, errors) apply as for the <a href="backend/struct.Handle.html#method.add_signal" title="method signal_hook::iterator::backend::Handle::add_signal"><code>Handle::add_signal</code></a>
|
|
|
method.</p>
|
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.pending" class="method"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#177-179">source</a><h4 class="code-header">pub fn <a href="#method.pending" class="fn">pending</a>(&mut self) -> <a class="struct" href="backend/struct.Pending.html" title="struct signal_hook::iterator::backend::Pending">Pending</a><E> <a href="#" class="tooltip" data-notable-ty="Pending<E>">ⓘ</a></h4></section></summary><div class="docblock"><p>Returns an iterator of already received signals.</p>
|
|
|
<p>This returns an iterator over all the signal numbers of the signals received since last
|
|
|
time they were read (out of the set registered by this <code>Signals</code> instance). Note that they
|
|
|
are returned in arbitrary order and a signal instance may returned only once even if it was
|
|
|
received multiple times.</p>
|
|
|
<p>This method returns immediately (does not block) and may produce an empty iterator if there
|
|
|
are no signals ready.</p>
|
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.wait" class="method"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#209-220">source</a><h4 class="code-header">pub fn <a href="#method.wait" class="fn">wait</a>(&mut self) -> <a class="struct" href="backend/struct.Pending.html" title="struct signal_hook::iterator::backend::Pending">Pending</a><E> <a href="#" class="tooltip" data-notable-ty="Pending<E>">ⓘ</a></h4></section></summary><div class="docblock"><p>Waits for some signals to be available and returns an iterator.</p>
|
|
|
<p>This is similar to <a href="struct.SignalsInfo.html#method.pending" title="method signal_hook::iterator::SignalsInfo::pending"><code>pending</code></a>. If there are no signals available, it
|
|
|
tries to wait for some to arrive. However, due to implementation details, this still can
|
|
|
produce an empty iterator.</p>
|
|
|
<p>This can block for arbitrary long time. If the <a href="backend/struct.Handle.html#method.close" title="method signal_hook::iterator::backend::Handle::close"><code>Handle::close</code></a> method is used in
|
|
|
another thread this method will return immediately.</p>
|
|
|
<p>Note that the blocking is done in this method, not in the iterator.</p>
|
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_closed" class="method"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#225-227">source</a><h4 class="code-header">pub fn <a href="#method.is_closed" class="fn">is_closed</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Is it closed?</p>
|
|
|
<p>See <a href="backend/struct.Handle.html#method.close" title="method signal_hook::iterator::backend::Handle::close"><code>close</code></a>.</p>
|
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.forever" class="method"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#268-270">source</a><h4 class="code-header">pub fn <a href="#method.forever" class="fn">forever</a>(&mut self) -> <a class="struct" href="struct.Forever.html" title="struct signal_hook::iterator::Forever">Forever</a><'_, E> <a href="#" class="tooltip" data-notable-ty="Forever<'_, E>">ⓘ</a></h4></section></summary><div class="docblock"><p>Get an infinite iterator over arriving signals.</p>
|
|
|
<p>The iterator’s <code>next()</code> blocks as necessary to wait for signals to arrive. This is adequate
|
|
|
if you want to designate a thread solely to handling signals. If multiple signals come at
|
|
|
the same time (between two values produced by the iterator), they will be returned in
|
|
|
arbitrary order. Multiple instances of the same signal may be collated.</p>
|
|
|
<p>This is also the iterator returned by <code>IntoIterator</code> implementation on <code>&mut Signals</code>.</p>
|
|
|
<p>This iterator terminates only if explicitly <a href="backend/struct.Handle.html#method.close" title="method signal_hook::iterator::backend::Handle::close">closed</a>.</p>
|
|
|
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>signal_hook::consts::signal::<span class="kw-2">*</span>;
|
|
|
<span class="kw">use </span>signal_hook::iterator::Signals;
|
|
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>signals = Signals::new(<span class="kw-2">&</span>[SIGUSR1, SIGUSR2])<span class="question-mark">?</span>;
|
|
|
<span class="kw">let </span>handle = signals.handle();
|
|
|
thread::spawn(<span class="kw">move </span>|| {
|
|
|
<span class="kw">for </span>signal <span class="kw">in </span>signals.forever() {
|
|
|
<span class="kw">match </span>signal {
|
|
|
SIGUSR1 => {},
|
|
|
SIGUSR2 => {},
|
|
|
<span class="kw">_ </span>=> <span class="macro">unreachable!</span>(),
|
|
|
}
|
|
|
}
|
|
|
});
|
|
|
handle.close();</code></pre></div>
|
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.handle" class="method"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#275-277">source</a><h4 class="code-header">pub fn <a href="#method.handle" class="fn">handle</a>(&self) -> <a class="struct" href="backend/struct.Handle.html" title="struct signal_hook::iterator::backend::Handle">Handle</a></h4></section></summary><div class="docblock"><p>Get a shareable handle to a <a href="backend/struct.Handle.html" title="struct signal_hook::iterator::backend::Handle"><code>Handle</code></a> for this instance.</p>
|
|
|
<p>This can be used to add further signals or close the <a href="type.Signals.html" title="type signal_hook::iterator::Signals"><code>Signals</code></a> instance.</p>
|
|
|
</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-Debug-for-SignalsInfo%3CE%3E" class="impl"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#280-288">source</a><a href="#impl-Debug-for-SignalsInfo%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<E> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.SignalsInfo.html" title="struct signal_hook::iterator::SignalsInfo">SignalsInfo</a><E><div class="where">where
|
|
|
E: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="exfiltrator/trait.Exfiltrator.html" title="trait signal_hook::iterator::exfiltrator::Exfiltrator">Exfiltrator</a>,
|
|
|
E::Storage: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></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/signal_hook/iterator/mod.rs.html#285-287">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">FmtResult</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26mut+SignalsInfo%3CE%3E" class="impl"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#290-296">source</a><a href="#impl-IntoIterator-for-%26mut+SignalsInfo%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<'a, E: <a class="trait" href="exfiltrator/trait.Exfiltrator.html" title="trait signal_hook::iterator::exfiltrator::Exfiltrator">Exfiltrator</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="struct.SignalsInfo.html" title="struct signal_hook::iterator::SignalsInfo">SignalsInfo</a><E></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <E as Exfiltrator>::Output</h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter" class="associatedtype trait-impl"><a href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="struct.Forever.html" title="struct signal_hook::iterator::Forever">Forever</a><'a, E></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter" class="method trait-impl"><a class="src rightside" href="../../src/signal_hook/iterator/mod.rs.html#293-295">source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">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-RefUnwindSafe-for-SignalsInfo%3CE%3E" class="impl"><a href="#impl-RefUnwindSafe-for-SignalsInfo%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<E = <a class="struct" href="exfiltrator/struct.SignalOnly.html" title="struct signal_hook::iterator::exfiltrator::SignalOnly">SignalOnly</a>> !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.SignalsInfo.html" title="struct signal_hook::iterator::SignalsInfo">SignalsInfo</a><E></h3></section><section id="impl-Send-for-SignalsInfo%3CE%3E" class="impl"><a href="#impl-Send-for-SignalsInfo%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<E> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.SignalsInfo.html" title="struct signal_hook::iterator::SignalsInfo">SignalsInfo</a><E></h3></section><section id="impl-Sync-for-SignalsInfo%3CE%3E" class="impl"><a href="#impl-Sync-for-SignalsInfo%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<E> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.SignalsInfo.html" title="struct signal_hook::iterator::SignalsInfo">SignalsInfo</a><E></h3></section><section id="impl-Unpin-for-SignalsInfo%3CE%3E" class="impl"><a href="#impl-Unpin-for-SignalsInfo%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<E> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.SignalsInfo.html" title="struct signal_hook::iterator::SignalsInfo">SignalsInfo</a><E></h3></section><section id="impl-UnwindSafe-for-SignalsInfo%3CE%3E" class="impl"><a href="#impl-UnwindSafe-for-SignalsInfo%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<E = <a class="struct" href="exfiltrator/struct.SignalOnly.html" title="struct signal_hook::iterator::exfiltrator::SignalOnly">SignalOnly</a>> !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.SignalsInfo.html" title="struct signal_hook::iterator::SignalsInfo">SignalsInfo</a><E></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.76.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.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.76.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.76.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.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.76.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-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.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.76.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#763">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> 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.76.0/src/core/convert/mod.rs.html#766">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> 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-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#747-749">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</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.76.0/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> 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.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> 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.76.0/src/core/convert/mod.rs.html#803-805">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></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.76.0/src/core/convert/mod.rs.html#788-790">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.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.76.0/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"Forever<'_, E>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.Forever.html\" title=\"struct signal_hook::iterator::Forever\">Forever</a><'a, E></code></h3><pre><code><div class=\"where\">impl<'a, E: <a class=\"trait\" href=\"exfiltrator/trait.Exfiltrator.html\" title=\"trait signal_hook::iterator::exfiltrator::Exfiltrator\">Exfiltrator</a>> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.Forever.html\" title=\"struct signal_hook::iterator::Forever\">Forever</a><'a, E></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = E::Output;</div>","Pending<E>":"<h3>Notable traits for <code><a class=\"struct\" href=\"backend/struct.Pending.html\" title=\"struct signal_hook::iterator::backend::Pending\">Pending</a><E></code></h3><pre><code><div class=\"where\">impl<E: <a class=\"trait\" href=\"exfiltrator/trait.Exfiltrator.html\" title=\"trait signal_hook::iterator::exfiltrator::Exfiltrator\">Exfiltrator</a>> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"backend/struct.Pending.html\" title=\"struct signal_hook::iterator::backend::Pending\">Pending</a><E></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = E::Output;</div>"}</script></section></div></main></body></html> |