Struct Location

pub struct Location { /* private fields */ }

A source code location in a function body.

To construct a Location, use location!().

Implementations

impl Location

pub fn frame<F>(self, f: F) -> impl Future<Output = F::Output>

where F: Future,

Include the given future in taskdumps with this location.

Examples

async fn foo() {
    async_backtrace::location!().frame(async move {
        bar().await;
        baz().await;
    }).await
}

pub const fn name(&self) -> Option<&str>

Produces the function name associated with this location.

pub const fn file(&self) -> &str

Produces the file name associated with this location.

pub const fn line(&self) -> u32

Produces the line number associated with this location.

pub const fn column(&self) -> u32

Produces the column number associated with this location.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Location

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Location

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Location

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Location

fn cmp(&self, other: &Location) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Location

fn eq(&self, other: &Location) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Location

fn partial_cmp(&self, other: &Location) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Location

impl Eq for Location

impl StructuralPartialEq for Location