| <!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="Cross platform handling of Ctrl-C signals."><meta name="keywords" content="rust, rustlang, rust-lang, ctrlc"><title>ctrlc - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[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><a class="sidebar-logo" href="../ctrlc/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../ctrlc/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate ctrlc</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 3.4.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">ctrlc</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/ctrlc/lib.rs.html#10-153">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Cross platform handling of Ctrl-C signals.</p> |
| <p><a href="fn.set_handler.html">set_handler()</a> allows setting a handler closure which is executed on |
| <code>Ctrl+C</code>. On Unix, this corresponds to a <code>SIGINT</code> signal. On windows, <code>Ctrl+C</code> corresponds to |
| <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms683242.aspx"><code>CTRL_C_EVENT</code></a> or <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms683242.aspx"><code>CTRL_BREAK_EVENT</code></a>.</p> |
| <p>Setting a handler will start a new dedicated signal handling thread where we |
| execute the handler each time we receive a <code>Ctrl+C</code> signal. There can only be |
| one handler, you would typically set one at the start of your program.</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::sync::atomic::{AtomicBool, Ordering}; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">fn </span>main() { |
| <span class="kw">let </span>running = Arc::new(AtomicBool::new(<span class="bool-val">true</span>)); |
| <span class="kw">let </span>r = running.clone(); |
| |
| ctrlc::set_handler(<span class="kw">move </span>|| { |
| r.store(<span class="bool-val">false</span>, Ordering::SeqCst); |
| }).expect(<span class="string">"Error setting Ctrl-C handler"</span>); |
| |
| <span class="macro">println!</span>(<span class="string">"Waiting for Ctrl-C..."</span>); |
| <span class="kw">while </span>running.load(Ordering::SeqCst) {} |
| <span class="macro">println!</span>(<span class="string">"Got it! Exiting..."</span>); |
| }</code></pre></div> |
| <h2 id="handling-sigterm-and-sighup"><a href="#handling-sigterm-and-sighup">Handling SIGTERM and SIGHUP</a></h2> |
| <p>Handling of <code>SIGTERM and SIGHUP</code> can be enabled with <code>termination</code> feature. If this is enabled, |
| the handler specified by <code>set_handler()</code> will be executed for <code>SIGINT</code>, <code>SIGTERM</code> and <code>SIGHUP</code>.</p> |
| </div></details><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="ctrlc::Error enum">Error</a></div><div class="item-right docblock-short">Ctrl-C error.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SignalType.html" title="ctrlc::SignalType enum">SignalType</a></div><div class="item-right docblock-short">A cross-platform way to represent Ctrl-C or program termination signal. Other |
| signals/events are supported via <code>Other</code>-variant.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.set_handler.html" title="ctrlc::set_handler fn">set_handler</a></div><div class="item-right docblock-short">Register signal handler for Ctrl-C.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_set_handler.html" title="ctrlc::try_set_handler fn">try_set_handler</a></div><div class="item-right docblock-short">The same as ctrlc::set_handler but errors if a handler already exists for the signal(s).</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Signal.html" title="ctrlc::Signal type">Signal</a></div><div class="item-right docblock-short">Platform specific signal type</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="ctrlc" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
