1.10.0[−][src]Struct maybe_std::panic::Location
A struct containing information about the location of a panic.
This structure is created by PanicInfo::location()
.
Examples
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");
Comparisons
Comparisons for equality and ordering are made in file, line, then column priority.
Files are compared as strings, not Path
, which could be unexpected.
See Location::file
's documentation for more discussion.
Implementations
impl<'a> Location<'a>
[src]
pub const fn caller() -> &'static Location<'static>
1.46.0[src]
Returns the source location of the caller of this function. If that function's caller is annotated then its call location will be returned, and so on up the stack to the first call within a non-tracked function body.
Examples
use core::panic::Location; /// Returns the [`Location`] at which it is called. #[track_caller] fn get_caller_location() -> &'static Location<'static> { Location::caller() } /// Returns a [`Location`] from within this function's definition. fn get_just_one_location() -> &'static Location<'static> { get_caller_location() } let fixed_location = get_just_one_location(); assert_eq!(fixed_location.file(), file!()); assert_eq!(fixed_location.line(), 14); assert_eq!(fixed_location.column(), 5); // running the same untracked function in a different location gives us the same result let second_fixed_location = get_just_one_location(); assert_eq!(fixed_location.file(), second_fixed_location.file()); assert_eq!(fixed_location.line(), second_fixed_location.line()); assert_eq!(fixed_location.column(), second_fixed_location.column()); let this_location = get_caller_location(); assert_eq!(this_location.file(), file!()); assert_eq!(this_location.line(), 28); assert_eq!(this_location.column(), 21); // running the tracked function in a different location produces a different value let another_location = get_caller_location(); assert_eq!(this_location.file(), another_location.file()); assert_ne!(this_location.line(), another_location.line()); assert_ne!(this_location.column(), another_location.column());
impl<'a> Location<'a>
[src]
pub fn file(&self) -> &str
[src]
Returns the name of the source file from which the panic originated.
&str
, not &Path
The returned name refers to a source path on the compiling system, but it isn't valid to
represent this directly as a &Path
. The compiled code may run on a different system with
a different Path
implementation than the system providing the contents and this library
does not currently have a different "host path" type.
The most surprising behavior occurs when "the same" file is reachable via multiple paths in
the module system (usually using the #[path = "..."]
attribute or similar), which can
cause what appears to be identical code to return differing values from this function.
Cross-compilation
This value is not suitable for passing to Path::new
or similar constructors when the host
platform and target platform differ.
Examples
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");
pub fn line(&self) -> u32
[src]
Returns the line number from which the panic originated.
Examples
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");
pub fn column(&self) -> u32
1.25.0[src]
Returns the column from which the panic originated.
Examples
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");
Trait Implementations
impl<'a> Clone for Location<'a>
[src]
fn clone(&self) -> Location<'a>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a> Copy for Location<'a>
[src]
impl<'a> Debug for Location<'a>
[src]
impl<'_> Display for Location<'_>
1.26.0[src]
impl<'a> Eq for Location<'a>
[src]
impl<'a> Hash for Location<'a>
[src]
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<'a> Ord for Location<'a>
[src]
fn cmp(&self, other: &Location<'a>) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<'a> PartialEq<Location<'a>> for Location<'a>
[src]
impl<'a> PartialOrd<Location<'a>> for Location<'a>
[src]
fn partial_cmp(&self, other: &Location<'a>) -> Option<Ordering>
[src]
fn lt(&self, other: &Location<'a>) -> bool
[src]
fn le(&self, other: &Location<'a>) -> bool
[src]
fn gt(&self, other: &Location<'a>) -> bool
[src]
fn ge(&self, other: &Location<'a>) -> bool
[src]
impl<'a> StructuralEq for Location<'a>
[src]
impl<'a> StructuralPartialEq for Location<'a>
[src]
Auto Trait Implementations
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,