<!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="Source to the Rust file `libcore/panicking.rs`."> <meta name="keywords" content="rust, rustlang, rust-lang"> <title>panicking.rs.html -- source</title> <link rel="stylesheet" type="text/css" href="../../normalize.css"> <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"> <link rel="stylesheet" type="text/css" href="../../dark.css"> <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle"> <script src="../../storage.js"></script> <link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"> </head> <body class="rustdoc source"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <nav class="sidebar"> <div class="sidebar-menu">☰</div> <a href='../../core/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a> </nav> <div class="theme-picker"> <button id="theme-picker" aria-label="Pick another theme!"> <img src="../../brush.svg" width="18" alt="Pick another theme!"> </button> <div id="theme-choices"></div> </div> <script src="../../theme.js"></script> <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"><pre class="line-numbers"><span id="1"> 1</span> <span id="2"> 2</span> <span id="3"> 3</span> <span id="4"> 4</span> <span id="5"> 5</span> <span id="6"> 6</span> <span id="7"> 7</span> <span id="8"> 8</span> <span id="9"> 9</span> <span id="10">10</span> <span id="11">11</span> <span id="12">12</span> <span id="13">13</span> <span id="14">14</span> <span id="15">15</span> <span id="16">16</span> <span id="17">17</span> <span id="18">18</span> <span id="19">19</span> <span id="20">20</span> <span id="21">21</span> <span id="22">22</span> <span id="23">23</span> <span id="24">24</span> <span id="25">25</span> <span id="26">26</span> <span id="27">27</span> <span id="28">28</span> <span id="29">29</span> <span id="30">30</span> <span id="31">31</span> <span id="32">32</span> <span id="33">33</span> <span id="34">34</span> <span id="35">35</span> <span id="36">36</span> <span id="37">37</span> <span id="38">38</span> <span id="39">39</span> <span id="40">40</span> <span id="41">41</span> <span id="42">42</span> <span id="43">43</span> <span id="44">44</span> <span id="45">45</span> <span id="46">46</span> <span id="47">47</span> <span id="48">48</span> <span id="49">49</span> <span id="50">50</span> <span id="51">51</span> <span id="52">52</span> <span id="53">53</span> <span id="54">54</span> <span id="55">55</span> <span id="56">56</span> <span id="57">57</span> <span id="58">58</span> <span id="59">59</span> <span id="60">60</span> <span id="61">61</span> <span id="62">62</span> <span id="63">63</span> <span id="64">64</span> <span id="65">65</span> <span id="66">66</span> <span id="67">67</span> <span id="68">68</span> <span id="69">69</span> <span id="70">70</span> <span id="71">71</span> <span id="72">72</span> </pre><pre class="rust "> <span class="comment">// Copyright 2014 The Rust Project Developers. See the COPYRIGHT</span> <span class="comment">// file at the top-level directory of this distribution and at</span> <span class="comment">// http://rust-lang.org/COPYRIGHT.</span> <span class="comment">//</span> <span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span> <span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span> <span class="comment">// option. This file may not be copied, modified, or distributed</span> <span class="comment">// except according to those terms.</span> <span class="doccomment">//! Panic support for libcore</span> <span class="doccomment">//!</span> <span class="doccomment">//! The core library cannot define panicking, but it does *declare* panicking. This</span> <span class="doccomment">//! means that the functions inside of libcore are allowed to panic, but to be</span> <span class="doccomment">//! useful an upstream crate must define panicking for libcore to use. The current</span> <span class="doccomment">//! interface for panicking is:</span> <span class="doccomment">//!</span> <span class="doccomment">//! ```</span> <span class="doccomment">//! # use std::fmt;</span> <span class="doccomment">//! fn panic_impl(fmt: fmt::Arguments, file_line_col: &(&'static str, u32, u32)) -> !</span> <span class="doccomment">//! # { loop {} }</span> <span class="doccomment">//! ```</span> <span class="doccomment">//!</span> <span class="doccomment">//! This definition allows for panicking with any general message, but it does not</span> <span class="doccomment">//! allow for failing with a `Box<Any>` value. The reason for this is that libcore</span> <span class="doccomment">//! is not allowed to allocate.</span> <span class="doccomment">//!</span> <span class="doccomment">//! This module contains a few other panicking functions, but these are just the</span> <span class="doccomment">//! necessary lang items for the compiler. All panics are funneled through this</span> <span class="doccomment">//! one function. Currently, the actual symbol is declared in the standard</span> <span class="doccomment">//! library, but the location of this may change over time.</span> <span class="attribute">#![<span class="ident">allow</span>(<span class="ident">dead_code</span>, <span class="ident">missing_docs</span>)]</span> <span class="attribute">#![<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"core_panic"</span>, <span class="ident">reason</span> <span class="op">=</span> <span class="string">"internal details of the implementation of the `panic!` \ and related macros"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"0"</span>)]</span> <span class="kw">use</span> <span class="ident">fmt</span>; <span class="attribute">#[<span class="ident">cold</span>]</span> <span class="attribute">#[<span class="ident">inline</span>(<span class="ident">never</span>)]</span> <span class="comment">// this is the slow path, always</span> <span class="attribute">#[<span class="ident">lang</span> <span class="op">=</span> <span class="string">"panic"</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">panic</span>(<span class="ident">expr_file_line_col</span>: <span class="kw-2">&</span>(<span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">u32</span>, <span class="ident">u32</span>)) <span class="op">-></span> <span class="op">!</span> { <span class="comment">// Use Arguments::new_v1 instead of format_args!("{}", expr) to potentially</span> <span class="comment">// reduce size overhead. The format_args! macro uses str's Display trait to</span> <span class="comment">// write expr, which calls Formatter::pad, which must accommodate string</span> <span class="comment">// truncation and padding (even though none is used here). Using</span> <span class="comment">// Arguments::new_v1 may allow the compiler to omit Formatter::pad from the</span> <span class="comment">// output binary, saving up to a few kilobytes.</span> <span class="kw">let</span> (<span class="ident">expr</span>, <span class="ident">file</span>, <span class="ident">line</span>, <span class="ident">col</span>) <span class="op">=</span> <span class="kw-2">*</span><span class="ident">expr_file_line_col</span>; <span class="ident">panic_fmt</span>(<span class="ident">fmt</span>::<span class="ident">Arguments</span>::<span class="ident">new_v1</span>(<span class="kw-2">&</span>[<span class="ident">expr</span>], <span class="kw-2">&</span>[]), <span class="kw-2">&</span>(<span class="ident">file</span>, <span class="ident">line</span>, <span class="ident">col</span>)) } <span class="attribute">#[<span class="ident">cold</span>]</span> <span class="attribute">#[<span class="ident">inline</span>(<span class="ident">never</span>)]</span> <span class="attribute">#[<span class="ident">lang</span> <span class="op">=</span> <span class="string">"panic_bounds_check"</span>]</span> <span class="kw">fn</span> <span class="ident">panic_bounds_check</span>(<span class="ident">file_line_col</span>: <span class="kw-2">&</span>(<span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">u32</span>, <span class="ident">u32</span>), <span class="ident">index</span>: <span class="ident">usize</span>, <span class="ident">len</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="op">!</span> { <span class="ident">panic_fmt</span>(<span class="macro">format_args</span><span class="macro">!</span>(<span class="string">"index out of bounds: the len is {} but the index is {}"</span>, <span class="ident">len</span>, <span class="ident">index</span>), <span class="ident">file_line_col</span>) } <span class="attribute">#[<span class="ident">cold</span>]</span> <span class="attribute">#[<span class="ident">inline</span>(<span class="ident">never</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">panic_fmt</span>(<span class="ident">fmt</span>: <span class="ident">fmt</span>::<span class="ident">Arguments</span>, <span class="ident">file_line_col</span>: <span class="kw-2">&</span>(<span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">u32</span>, <span class="ident">u32</span>)) <span class="op">-></span> <span class="op">!</span> { <span class="attribute">#[<span class="ident">allow</span>(<span class="ident">improper_ctypes</span>)]</span> <span class="kw">extern</span> { <span class="attribute">#[<span class="ident">lang</span> <span class="op">=</span> <span class="string">"panic_fmt"</span>]</span> <span class="attribute">#[<span class="ident">unwind</span>]</span> <span class="kw">fn</span> <span class="ident">panic_impl</span>(<span class="ident">fmt</span>: <span class="ident">fmt</span>::<span class="ident">Arguments</span>, <span class="ident">file</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">line</span>: <span class="ident">u32</span>, <span class="ident">col</span>: <span class="ident">u32</span>) <span class="op">-></span> <span class="op">!</span>; } <span class="kw">let</span> (<span class="ident">file</span>, <span class="ident">line</span>, <span class="ident">col</span>) <span class="op">=</span> <span class="kw-2">*</span><span class="ident">file_line_col</span>; <span class="kw">unsafe</span> { <span class="ident">panic_impl</span>(<span class="ident">fmt</span>, <span class="ident">file</span>, <span class="ident">line</span>, <span class="ident">col</span>) } } </pre> </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><kbd>?</kbd></dt> <dd>Show this help dialog</dd> <dt><kbd>S</kbd></dt> <dd>Focus the search field</dd> <dt><kbd>↑</kbd></dt> <dd>Move up in search results</dd> <dt><kbd>↓</kbd></dt> <dd>Move down in search results</dd> <dt><kbd>↹</kbd></dt> <dd>Switch tab</dd> <dt><kbd>⏎</kbd></dt> <dd>Go to active search result</dd> <dt><kbd>+</kbd></dt> <dd>Expand all sections</dd> <dt><kbd>-</kbd></dt> <dd>Collapse 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 = "core"; </script> <script src="../../main.js"></script> <script defer src="../../search-index.js"></script> </body> </html>