panicking.rs.html -- source
Description: Source to the Rust file `libcore/panicking.rs`.
Keywords: rust, rustlang, rust-lang

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78

    // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! Panic support for libcore
    //!
    //! The core library cannot define panicking, but it does *declare* panicking. This
    //! means that the functions inside of libcore are allowed to panic, but to be
    //! useful an upstream crate must define panicking for libcore to use. The current
    //! interface for panicking is:
    //!
    //! ```
    //! # use std::fmt;
    //! fn panic_impl(fmt: fmt::Arguments, file_line_col: &(&'static str, u32, u32)) -> !
    //! # { loop {} }
    //! ```
    //!
    //! This definition allows for panicking with any general message, but it does not
    //! allow for failing with a `Box<Any>` value. The reason for this is that libcore
    //! is not allowed to allocate.
    //!
    //! This module contains a few other panicking functions, but these are just the
    //! necessary lang items for the compiler. All panics are funneled through this
    //! one function. Currently, the actual symbol is declared in the standard
    //! library, but the location of this may change over time.

    #![allow(dead_code, missing_docs)]
    #![unstable(feature = "core_panic",
                reason = "internal details of the implementation of the `panic!` \
                          and related macros",
                issue = "0")]

    use fmt;
    use panic::{Location, PanicInfo};

    #[cold] #[inline(never)] // this is the slow path, always
    #[lang = "panic"]
    pub fn panic(expr_file_line_col: &(&'static str, &'static str, u32, u32)) -> ! {
        // Use Arguments::new_v1 instead of format_args!("{}", expr) to potentially
        // reduce size overhead. The format_args! macro uses str's Display trait to
        // write expr, which calls Formatter::pad, which must accommodate string
        // truncation and padding (even though none is used here). Using
        // Arguments::new_v1 may allow the compiler to omit Formatter::pad from the
        // output binary, saving up to a few kilobytes.
        let (expr, file, line, col) = *expr_file_line_col;
        panic_fmt(fmt::Arguments::new_v1(&[expr], &[]), &(file, line, col))
    }

    #[cold] #[inline(never)]
    #[lang = "panic_bounds_check"]
    fn panic_bounds_check(file_line_col: &(&'static str, u32, u32),
                         index: usize, len: usize) -> ! {
        panic_fmt(format_args!("index out of bounds: the len is {} but the index is {}",
                               len, index), file_line_col)
    }

    #[cold] #[inline(never)]
    pub fn panic_fmt(fmt: fmt::Arguments, file_line_col: &(&'static str, u32, u32)) -> ! {
        // NOTE This function never crosses the FFI boundary; it's a Rust-to-Rust call
        #[allow(improper_ctypes)] // PanicInfo contains a trait object which is not FFI safe
        extern "Rust" {
            #[lang = "panic_impl"]
            fn panic_impl(pi: &PanicInfo) -> !;
        }

        let (file, line, col) = *file_line_col;
        let pi = PanicInfo::internal_constructor(
            Some(&fmt),
            Location::internal_constructor(file, line, col),
        );
        unsafe { panic_impl(&pi) }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)