      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
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269

    // Copyright 2018 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 in the standard library.

    #![unstable(feature = "core_panic_info",
                reason = "newly available in libcore",
                issue = "44489")]

    use any::Any;
    use fmt;

    /// A struct providing information about a panic.
    ///
    /// `PanicInfo` structure is passed to a panic hook set by the [`set_hook`]
    /// function.
    ///
    /// [`set_hook`]: ../../std/panic/fn.set_hook.html
    ///
    /// # Examples
    ///
    /// ```should_panic
    /// use std::panic;
    ///
    /// panic::set_hook(Box::new(|panic_info| {
    ///     println!("panic occurred: {:?}", panic_info.payload().downcast_ref::<&str>().unwrap());
    /// }));
    ///
    /// panic!("Normal panic");
    /// ```
    #[stable(feature = "panic_hooks", since = "1.10.0")]
    #[derive(Debug)]
    pub struct PanicInfo<'a> {
        payload: &'a (Any + Send),
        message: Option<&'a fmt::Arguments<'a>>,
        location: Location<'a>,
    }

    impl<'a> PanicInfo<'a> {
        #![unstable(feature = "panic_internals",
                    reason = "internal details of the implementation of the `panic!` \
                              and related macros",
                    issue = "0")]
        #[doc(hidden)]
        #[inline]
        pub fn internal_constructor(message: Option<&'a fmt::Arguments<'a>>,
                                    location: Location<'a>)
                                    -> Self {
            PanicInfo { payload: &(), location, message }
        }

        #[doc(hidden)]
        #[inline]
        pub fn set_payload(&mut self, info: &'a (Any + Send)) {
            self.payload = info;
        }

        /// Returns the payload associated with the panic.
        ///
        /// This will commonly, but not always, be a `&'static str` or [`String`].
        ///
        /// [`String`]: ../../std/string/struct.String.html
        ///
        /// # Examples
        ///
        /// ```should_panic
        /// use std::panic;
        ///
        /// panic::set_hook(Box::new(|panic_info| {
        ///     println!("panic occurred: {:?}", panic_info.payload().downcast_ref::<&str>().unwrap());
        /// }));
        ///
        /// panic!("Normal panic");
        /// ```
        #[stable(feature = "panic_hooks", since = "1.10.0")]
        pub fn payload(&self) -> &(Any + Send) {
            self.payload
        }

        /// If the `panic!` macro from the `core` crate (not from `std`)
        /// was used with a formatting string and some additional arguments,
        /// returns that message ready to be used for example with [`fmt::write`]
        ///
        /// [`fmt::write`]: ../fmt/fn.write.html
        #[unstable(feature = "panic_info_message", issue = "44489")]
        pub fn message(&self) -> Option<&fmt::Arguments> {
            self.message
        }

        /// Returns information about the location from which the panic originated,
        /// if available.
        ///
        /// This method will currently always return [`Some`], but this may change
        /// in future versions.
        ///
        /// [`Some`]: ../../std/option/enum.Option.html#variant.Some
        ///
        /// # Examples
        ///
        /// ```should_panic
        /// use std::panic;
        ///
        /// panic::set_hook(Box::new(|panic_info| {
        ///     if let Some(location) = panic_info.location() {
        ///         println!("panic occurred in file '{}' at line {}", location.file(),
        ///             location.line());
        ///     } else {
        ///         println!("panic occurred but can't get location information...");
        ///     }
        /// }));
        ///
        /// panic!("Normal panic");
        /// ```
        #[stable(feature = "panic_hooks", since = "1.10.0")]
        pub fn location(&self) -> Option<&Location> {
            // NOTE: If this is changed to sometimes return None,
            // deal with that case in std::panicking::default_hook.
            Some(&self.location)
        }
    }

    #[stable(feature = "panic_hook_display", since = "1.26.0")]
    impl<'a> fmt::Display for PanicInfo<'a> {
        fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            formatter.write_str("panicked at ")?;
            if let Some(message) = self.message {
                write!(formatter, "'{}', ", message)?
            } else if let Some(payload) = self.payload.downcast_ref::<&'static str>() {
                write!(formatter, "'{}', ", payload)?
            }
            // NOTE: we cannot use downcast_ref::<String>() here
            // since String is not available in libcore!
            // The payload is a String when `std::panic!` is called with multiple arguments,
            // but in that case the message is also available.

            self.location.fmt(formatter)
        }
    }

    /// A struct containing information about the location of a panic.
    ///
    /// This structure is created by the [`location`] method of [`PanicInfo`].
    ///
    /// [`location`]: ../../std/panic/struct.PanicInfo.html#method.location
    /// [`PanicInfo`]: ../../std/panic/struct.PanicInfo.html
    ///
    /// # Examples
    ///
    /// ```should_panic
    /// use std::panic;
    ///
    /// panic::set_hook(Box::new(|panic_info| {
    ///     if let Some(location) = panic_info.location() {
    ///         println!("panic occurred in file '{}' at line {}", location.file(), location.line());
    ///     } else {
    ///         println!("panic occurred but can't get location information...");
    ///     }
    /// }));
    ///
    /// panic!("Normal panic");
    /// ```
    #[derive(Debug)]
    #[stable(feature = "panic_hooks", since = "1.10.0")]
    pub struct Location<'a> {
        file: &'a str,
        line: u32,
        col: u32,
    }

    impl<'a> Location<'a> {
        #![unstable(feature = "panic_internals",
                    reason = "internal details of the implementation of the `panic!` \
                              and related macros",
                    issue = "0")]
        #[doc(hidden)]
        pub fn internal_constructor(file: &'a str, line: u32, col: u32) -> Self {
            Location { file, line, col }
        }

        /// Returns the name of the source file from which the panic originated.
        ///
        /// # Examples
        ///
        /// ```should_panic
        /// use std::panic;
        ///
        /// panic::set_hook(Box::new(|panic_info| {
        ///     if let Some(location) = panic_info.location() {
        ///         println!("panic occurred in file '{}'", location.file());
        ///     } else {
        ///         println!("panic occurred but can't get location information...");
        ///     }
        /// }));
        ///
        /// panic!("Normal panic");
        /// ```
        #[stable(feature = "panic_hooks", since = "1.10.0")]
        pub fn file(&self) -> &str {
            self.file
        }

        /// Returns the line number from which the panic originated.
        ///
        /// # Examples
        ///
        /// ```should_panic
        /// use std::panic;
        ///
        /// panic::set_hook(Box::new(|panic_info| {
        ///     if let Some(location) = panic_info.location() {
        ///         println!("panic occurred at line {}", location.line());
        ///     } else {
        ///         println!("panic occurred but can't get location information...");
        ///     }
        /// }));
        ///
        /// panic!("Normal panic");
        /// ```
        #[stable(feature = "panic_hooks", since = "1.10.0")]
        pub fn line(&self) -> u32 {
            self.line
        }

        /// Returns the column from which the panic originated.
        ///
        /// # Examples
        ///
        /// ```should_panic
        /// use std::panic;
        ///
        /// panic::set_hook(Box::new(|panic_info| {
        ///     if let Some(location) = panic_info.location() {
        ///         println!("panic occurred at column {}", location.column());
        ///     } else {
        ///         println!("panic occurred but can't get location information...");
        ///     }
        /// }));
        ///
        /// panic!("Normal panic");
        /// ```
        #[stable(feature = "panic_col", since = "1.25.0")]
        pub fn column(&self) -> u32 {
            self.col
        }
    }

    #[stable(feature = "panic_hook_display", since = "1.26.0")]
    impl<'a> fmt::Display for Location<'a> {
        fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            write!(formatter, "{}:{}:{}", self.file, self.line, self.col)
        }
    }

    /// An internal trait used by libstd to pass data from libstd to `panic_unwind`
    /// and other panic runtimes. Not intended to be stabilized any time soon, do
    /// not use.
    #[unstable(feature = "std_internals", issue = "0")]
    #[doc(hidden)]
    pub unsafe trait BoxMeUp {
        fn box_me_up(&mut self) -> *mut (Any + Send);
        fn get(&mut self) -> &(Any + Send);
    }

# 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`)