|
|
<!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="A backend module for implementing the iterator like `iterator` module and the asynchronous adapter crates."><title>signal_hook::iterator::backend - 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 mod"><!--[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="#">Module backend</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Aliases</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>Module <a href="../../index.html">signal_hook</a>::<wbr><a href="../index.html">iterator</a>::<wbr><a class="mod" href="#">backend</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/backend.rs.html#1-494">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A backend module for implementing the iterator like
|
|
|
<a href="../index.html" title="mod signal_hook::iterator"><code>iterator</code></a> module and the asynchronous
|
|
|
adapter crates.</p>
|
|
|
<p>This module contains generic types which abstract over the concrete
|
|
|
IO type for the self-pipe. The motivation for having this abstraction
|
|
|
are the adapter crates for different asynchronous runtimes. The runtimes
|
|
|
provide their own wrappers for <a href="https://doc.rust-lang.org/1.76.0/std/os/unix/net/stream/struct.UnixStream.html" title="struct std::os::unix::net::stream::UnixStream"><code>std::os::unix::net::UnixStream</code></a>
|
|
|
which should be used as the internal self pipe. But large parts of the
|
|
|
remaining functionality doesn’t depend directly onto the IO type and can
|
|
|
be reused.</p>
|
|
|
<p>See also the <a href="struct.SignalDelivery.html#method.with_pipe" title="associated function signal_hook::iterator::backend::SignalDelivery::with_pipe"><code>SignalDelivery::with_pipe</code></a> method for more information
|
|
|
about requirements the IO types have to fulfill.</p>
|
|
|
<p>As a regular user you shouldn’t need to use the types in this module.
|
|
|
Use the <a href="../type.Signals.html" title="type signal_hook::iterator::Signals"><code>Signals</code></a> struct or one of the types
|
|
|
contained in the adapter libraries instead.</p>
|
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Handle.html" title="struct signal_hook::iterator::backend::Handle">Handle</a></div><div class="desc docblock-short">A struct to control an instance of an associated type
|
|
|
(like for example <a href="../type.Signals.html" title="type signal_hook::iterator::Signals"><code>Signals</code></a>).</div></li><li><div class="item-name"><a class="struct" href="struct.Pending.html" title="struct signal_hook::iterator::backend::Pending">Pending</a></div><div class="desc docblock-short">The iterator of one batch of signals.</div></li><li><div class="item-name"><a class="struct" href="struct.SignalDelivery.html" title="struct signal_hook::iterator::backend::SignalDelivery">SignalDelivery</a></div><div class="desc docblock-short">A struct for delivering received signals to the main program flow.
|
|
|
The self-pipe IO type is generic. See the
|
|
|
<a href="struct.SignalDelivery.html#method.with_pipe" title="associated function signal_hook::iterator::backend::SignalDelivery::with_pipe"><code>with_pipe</code></a> method for requirements
|
|
|
for the IO type.</div></li><li><div class="item-name"><a class="struct" href="struct.SignalIterator.html" title="struct signal_hook::iterator::backend::SignalIterator">SignalIterator</a></div><div class="desc docblock-short">An infinite iterator of received signals.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.PollResult.html" title="enum signal_hook::iterator::backend::PollResult">PollResult</a></div><div class="desc docblock-short">Possible results of the <a href="struct.SignalIterator.html#method.poll_signal" title="method signal_hook::iterator::backend::SignalIterator::poll_signal"><code>poll_signal</code></a> function.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.OwningSignalIterator.html" title="type signal_hook::iterator::backend::OwningSignalIterator">OwningSignalIterator</a></div><div class="desc docblock-short">A signal iterator which consumes a <a href="struct.SignalDelivery.html" title="struct signal_hook::iterator::backend::SignalDelivery"><code>SignalDelivery</code></a> instance and takes
|
|
|
ownership of it.</div></li><li><div class="item-name"><a class="type" href="type.RefSignalIterator.html" title="type signal_hook::iterator::backend::RefSignalIterator">RefSignalIterator</a></div><div class="desc docblock-short">A signal iterator which takes a mutable reference to a <a href="struct.SignalDelivery.html" title="struct signal_hook::iterator::backend::SignalDelivery"><code>SignalDelivery</code></a>
|
|
|
instance.</div></li></ul></section></div></main></body></html> |