Struct specifications::profiling::ProfileScopeHandle

pub struct ProfileScopeHandle<'s> { /* private fields */ }

Provides a convenience wrapper around a reference to a ProfileScope.

Implementations

impl ProfileScopeHandle<'static>

pub fn dummy() -> Self

Provides a dummy handle for if you are not interested in profiling, but need to use the functions.

impl<'s> ProfileScopeHandle<'s>

pub fn finish(self)

Finishes a scope, by janking the handle wrapping it out-of-scope.

Methods from Deref<Target = ProfileScope>

pub fn time(&self, name: impl Into<String>) -> TimerGuard<'_>

Returns a TimerGuard, which takes a time exactly as long as it is in scope.

Arguments

• name: The name to set for this Timing.

Returns

A new Timer struct to take a timing.

pub fn time_func<R>( &self, name: impl Into<String>, func: impl FnOnce() -> R, ) -> R

Profiles the given function and adds its timing under the given name.

Arguments

• name: The name to set for this Timing.
• func: The function to profile.

Returns

The result of the function, if any.

pub fn time_fut<'s, R>( &'s self, name: impl Into<String>, fut: impl 's + Future<Output = R>, ) -> impl 's + Future<Output = R>

Profiles the given future by creating a future that times it while running.

Arguments

• name: The name to set for this Timing.
• fut: The Future to profile.

Returns

A future that returns the same result as the given, but times its execution as a side-effect.

pub fn nest(&self, name: impl Into<String>) -> ProfileScopeHandle<'_>

Returns a new ProfileScope that can be used to do more elaborate nested timings.

Arguments

• name: The name of the new scope.

Returns

A new ProfileScope that can be used to take timings.

pub fn nest_func<R>( &self, name: impl Into<String>, func: impl FnOnce(ProfileScopeHandle<'_>) -> R, ) -> R

Profiles the given function, but provides it with extra profile options by giving it its own ProfileScope to populate.

Note that the ProfileScope is already automatically given a “total”-timing, representing the function’s profiling. This is still untimed as long as the function sees it, obviously.

Arguments

• name: The name to set for this Timing.
• func: The function to profile.

Returns

The result of the function, if any.

pub fn nest_fut<'s, F: Future>( &'s self, name: impl Into<String>, fut: impl 's + FnOnce(ProfileScopeHandle<'s>) -> F, ) -> impl 's + Future<Output = F::Output>

Profiles the given future by creating a future that times it while running, but provides it with extra profile options by giving it its own ProfileScope to popupate.

Note that the ProfileScope is already automatically given a “total”-timing, representing the future’s profiling. This is still untimed as long as the future sees it, obviously.

Arguments

• name: The name to set for this Timing.
• fut: The Future to profile.

Returns

A future that returns the same result as the given, but times its execution as a side-effect.

pub fn display(&self) -> ProfileScopeFormatter<'_>

Returns a formatter that neatly displays the results of this scope.

Note that this does not end with a newline, so typically you want to call writeln!()/println!() on this.

Returns

A new ProfileScopeFormatter.

pub fn display_indented(&self, indent: usize) -> ProfileScopeFormatter<'_>

Returns a formatter that neatly displays the results of this scope with a given number of spaces before each line.

Note that this does not end with a newline, so typically you want to call writeln!()/println!() on this.

Arguments

• indent: The number of spaces to print before each line.

Returns

A new ProfileScopeFormatter.

Trait Implementations

impl<'s> Clone for ProfileScopeHandle<'s>

fn clone(&self) -> ProfileScopeHandle<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for ProfileScopeHandle<'s>

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

Formats the value using the given formatter.

impl<'s> Deref for ProfileScopeHandle<'s>

type Target = ProfileScope

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'s> From<ProfileScopeHandle<'s>> for ProfileScopeHandleOwned

fn from(value: ProfileScopeHandle<'s>) -> Self

Converts to this type from the input type.