<!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="API documentation for the Rust `panic` macro in crate `std`."> <meta name="keywords" content="rust, rustlang, rust-lang, panic"> <title>std::panic - Rust</title> <link rel="stylesheet" type="text/css" href="../normalize.css"> <link rel="stylesheet" type="text/css" href="../rustdoc.css"> <link rel="stylesheet" type="text/css" href="../main.css"> <link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"> </head> <body class="rustdoc macro"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <nav class="sidebar"> <a href='../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a> <p class='location'><a href='index.html'>std</a></p><script>window.sidebarCurrent = {name: 'panic', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script> </nav> <nav class="sub"> <form class="search-form js-only"> <div class="search-container"> <input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"> </div> </form> </nav> <section id='main' class="content"> <h1 class='fqn'><span class='in-band'>Macro <a href='index.html'>std</a>::<wbr><a class="macro" href=''>panic</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'> <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> [<span class='inner'>−</span>] </a> </span><a class='srclink' href='../src/std/macros.rs.html#39-60' title='goto source code'>[src]</a></span></h1> <pre class="rust macro"> <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">panic</span> { () <span class="op">=></span> { ... }; (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">msg</span>:<span class="ident">expr</span>) <span class="op">=></span> { ... }; (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">fmt</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=></span> { ... }; }</pre> <div class='docblock'><p>The entry point for panic of Rust threads.</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<Any></code> type, and the single-argument form of the <code>panic!</code> macro will be the value which is transmitted.</p> <p>The multi-argument form of this macro panics with a string and has the <code>format!</code> syntax for building a string.</p> <h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1> <pre class="rust rust-example-rendered"> <span class="macro">panic</span><span class="macro">!</span>(); <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"this is a terrible mistake!"</span>); <span class="macro">panic</span><span class="macro">!</span>(<span class="number">4</span>); <span class="comment">// panic with the value of 4 to be collected elsewhere</span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"this is a {} {message}"</span>, <span class="string">"fancy"</span>, <span class="ident">message</span> <span class="op">=</span> <span class="string">"message"</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unreachable_code)%5D%0Afn%20main()%20%7B%0Apanic!()%3B%0Apanic!(%22this%20is%20a%20terrible%20mistake!%22)%3B%0Apanic!(4)%3B%20%2F%2F%20panic%20with%20the%20value%20of%204%20to%20be%20collected%20elsewhere%0Apanic!(%22this%20is%20a%20%7B%7D%20%7Bmessage%7D%22%2C%20%22fancy%22%2C%20message%20%3D%20%22message%22)%3B%0A%7D">Run</a></pre> </div></section> <section id='search' class="content hidden"></section> <section class="footer"></section> <aside id="help" class="hidden"> <div> <h1 class="hidden">Help</h1> <div class="shortcuts"> <h2>Keyboard Shortcuts</h2> <dl> <dt>?</dt> <dd>Show this help dialog</dd> <dt>S</dt> <dd>Focus the search field</dd> <dt>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</dt> <dd>Go to active search result</dd> <dt>+</dt> <dd>Collapse/expand all sections</dd> </dl> </div> <div class="infos"> <h2>Search Tricks</h2> <p> Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type. </p> <p> Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>. </p> <p> Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>) </p> </div> </div> </aside> <script> window.rootPath = "../"; window.currentCrate = "std"; </script> <script src="../main.js"></script> <script defer src="../search-index.js"></script> </body> </html>