<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/libcore/macros/panic.md - fork/rust @ 1.41.1</title>
<meta name="description" content="src/libcore/macros/panic.md in fork/rust at 1.41.1.">
<meta property="og:title" content="src/libcore/macros/panic.md - fork/rust @ 1.41.1">
<meta property="og:description" content="src/libcore/macros/panic.md in fork/rust at 1.41.1.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="1.41.1" data-tip="f3e1a954d2ead4e2fc197c7da7d71e6c61bad196">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="f3e1a954d2ead4e2fc197c7da7d71e6c61bad196">Auto merge of #69444 - pietroalbini:stable-next-final-v2-new, r=pietroalbini</span><span class="snapshot-sha sha" data-commit="f3e1a954d2ead4e2fc197c7da7d71e6c61bad196">f3e1a954d2e</span><time datetime="2020-02-24T22:43:10+00:00" title="2020-02-24 22:43:10 +0000">2020-02-24</time></p>
<header class="topbar"><details class="switcher"><summary>1.41.1</summary><div class="menu"><strong>branches</strong><a href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a class="current" href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/1.41.1/tree/src/">src</a> / <a href="/fork/rust/ref/1.41.1/tree/src/libcore/">libcore</a> / <a href="/fork/rust/ref/1.41.1/tree/src/libcore/macros/">macros</a> / <span class="cur">panic.md</span></nav>
<span class="view-stats"><span>1.8 KiB</span><span>47 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/3ecfc43be049b534478bb5bdaf58dfac63f31a94/src/libcore/macros/panic.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><p>Panics the current thread.</p>
<p>This allows a program to terminate immediately and provide feedback
to the caller of the program. <code>panic!</code> should be used when a program reaches
an unrecoverable state.</p>
<p>This macro is the perfect way to assert conditions in example code and in
tests. <code>panic!</code> is closely tied with the <code>unwrap</code> method of both <a href="../std/option/enum.Option.html#method.unwrap"><code>Option</code></a>
and <a href="../std/result/enum.Result.html#method.unwrap"><code>Result</code></a> enums. Both implementations call <code>panic!</code> when they are set
to None or Err variants.</p>
<p>This macro is used to inject panic into a Rust thread, causing the thread to
panic entirely. Each thread's panic can be reaped as the <code>Box&lt;Any&gt;</code> type,
and the single-argument form of the <code>panic!</code> macro will be the value which
is transmitted.</p>
<p><a href="../std/result/enum.Result.html"><code>Result</code></a> enum is often a better solution for recovering from errors than
using the <code>panic!</code> macro. This macro should be used to avoid proceeding using
incorrect values, such as from external sources. Detailed information about
error handling is found in the <a href="../book/ch09-00-error-handling.html">book</a>.</p>
<p>The multi-argument form of this macro panics with a string and has the
<a href="../std/macro.format.html"><code>format!</code></a> syntax for building a string.</p>
<p>See also the macro <a href="../std/macro.compile_error.html"><code>compile_error!</code></a>, for raising errors during compilation.</p>
<h1>Current implementation</h1>
<p>If the main thread panics it will terminate all your threads and end your
program with code <code>101</code>.</p>
<h1>Examples</h1>
<pre># #![allow(unreachable_code)]
panic!();
panic!(&quot;this is a terrible mistake!&quot;);
panic!(4); // panic with the value of 4 to be collected elsewhere
panic!(&quot;this is a {} {message}&quot;, &quot;fancy&quot;, message = &quot;message&quot;);
</pre>
</section><div class="code-panel"><pre class="code src" data-hl="src/libcore/macros/panic.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text">Panics the current thread.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">This allows a program to terminate immediately and provide feedback</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">to the caller of the program. `panic!` should be used when a program reaches</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">an unrecoverable state.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">This macro is the perfect way to assert conditions in example code and in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">tests. `panic!` is closely tied with the `unwrap` method of both [`Option`]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">and [`Result`][runwrap] enums. Both implementations call `panic!` when they are set</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">to None or Err variants.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">This macro is used to inject panic into a Rust thread, causing the thread to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">panic entirely. Each thread's panic can be reaped as the `Box&lt;Any&gt;` type,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">and the single-argument form of the `panic!` macro will be the value which</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">is transmitted.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">[`Result`] enum is often a better solution for recovering from errors than</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">using the `panic!` macro. This macro should be used to avoid proceeding using</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">incorrect values, such as from external sources. Detailed information about</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">error handling is found in the [book].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">The multi-argument form of this macro panics with a string and has the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">[`format!`] syntax for building a string.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">See also the macro [`compile_error!`], for raising errors during compilation.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">[runwrap]: ../std/result/enum.Result.html#method.unwrap</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">[`Option`]: ../std/option/enum.Option.html#method.unwrap</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">[`Result`]: ../std/result/enum.Result.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">[`format!`]: ../std/macro.format.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">[`compile_error!`]: ../std/macro.compile_error.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">[book]: ../book/ch09-00-error-handling.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"># Current implementation</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">If the main thread panics it will terminate all your threads and end your</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">program with code `101`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"># Examples</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">```should_panic</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"># #![allow(unreachable_code)]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text">panic!();</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">panic!(&quot;this is a terrible mistake!&quot;);</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">panic!(4); // panic with the value of 4 to be collected elsewhere</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">panic!(&quot;this is a {} {message}&quot;, &quot;fancy&quot;, message = &quot;message&quot;);</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">```</span></span></pre></div></div>
</main>
</body>
</html>
