14 lines
4.5 KiB
HTML
14 lines
4.5 KiB
HTML
<!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="Removes a previously installed action."><title>unregister in signal_hook_registry - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="signal_hook_registry" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">unregister</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../signal_hook_registry/index.html">signal_<wbr>hook_<wbr>registry</a><span class="version">1.4.8</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">unregister</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#warning" title="Warning">Warning</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate signal_<wbr>hook_<wbr>registry</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">signal_hook_registry</a></div><h1>Function <span class="fn">unregister</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/signal_hook_registry/lib.rs.html#703-715">Source</a> </span></div><pre class="rust item-decl"><code>pub fn unregister(id: <a class="struct" href="struct.SigId.html" title="struct signal_hook_registry::SigId">SigId</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Removes a previously installed action.</p>
|
||
<p>This function does nothing if the action was already removed. It returns true if it was removed
|
||
and false if the action wasn’t found.</p>
|
||
<p>It can unregister all the actions installed by <a href="fn.register.html" title="fn signal_hook_registry::register"><code>register</code></a> as well as the ones from downstream
|
||
crates (like <a href="https://docs.rs/signal-hook"><code>signal-hook</code></a>).</p>
|
||
<h2 id="warning"><a class="doc-anchor" href="#warning">§</a>Warning</h2>
|
||
<p>This does <em>not</em> currently return the default/previous signal handler if the last action for a
|
||
signal was just unregistered. That means that if you replaced for example <code>SIGTERM</code> and then
|
||
removed the action, the program will effectively ignore <code>SIGTERM</code> signals from now on, not
|
||
terminate on them as is the default action. This is OK if you remove it as part of a shutdown,
|
||
but it is not recommended to remove termination actions during the normal runtime of
|
||
application (unless the desired effect is to create something that can be terminated only by
|
||
SIGKILL).</p>
|
||
</div></details></section></div></main></body></html> |