Struct specifications::profiling::ProfileReport

source ·

pub struct ProfileReport<W: Write> { /* private fields */ }

Expand description

Defines the toplevel ProfileReport that writes to stdout or disk or whatever when it goes out-of-scope.

Implementations§

source §

impl ProfileReport<File>

source

pub fn auto_reporting_file( name: impl Into<String>, file_name: impl Into<String>, ) -> Self

Constructor for the ProfileReport that will write it to a file in a default location (/logs/profile) with a default name (date & time of the profile state) when it goes out-of-scope.

§Arguments

name: The name for the toplevel scope in this report.
filename: A more snake-case-like filename for the file.

§Returns

A new ProfileReport instance.

source §

impl<W: Write> ProfileReport<W>

source

pub fn auto_reporting(name: impl Into<String>, writer: impl Into<W>) -> Self

Constructor for the ProfileReport that will write it to the given Writer when it goes out-of-scope.

§Arguments

name: The name for the toplevel scope in this report.
writer: The Write-enabled writer that we will write to upon dropping.

§Returns

A new ProfileReport instance.

source

pub fn scope(&self) -> &ProfileScope

Returns the inner scope that can be used without worrying about auto-reporting.

§Returns

A reference to the ProfileScope that can be used to do anything except the gnarly auto-reporting.

source

pub fn into_scope(self) -> ProfileScope

Returns the inner scope that can be used without worrying about auto-reporting.

§Returns

A ProfileScope that can be used to do anything except the gnarly auto-reporting.

Methods from Deref<Target = ProfileScope>§

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.