Struct Profiler 

pub struct Profiler { /* private fields */ }

A lightweight profiler that collects named timing events.

Example

use shrew::profiler::Profiler;

let mut prof = Profiler::new();
let t = prof.start_event("forward", "compute");
// ... do work ...
prof.end_event(t, "forward", "compute");
let report = prof.report();
println!("{}", report);

Implementations

impl Profiler

pub fn new() -> Self

Create a new empty profiler.

pub fn start_event(&mut self, name: &str, _category: &str) -> Instant

Mark the start of a named event. Returns the Instant.

pub fn end_event(&mut self, start: Instant, name: &str, category: &str)

End an event started with [start_event]. Records elapsed time.

pub fn measure<F, R>(&mut self, name: &str, category: &str, f: F) -> R

where F: FnOnce() -> R,

Measure a closure and record it as a named event.

pub fn events(&self) -> &[ProfileEvent]

Return all recorded events.

pub fn clear(&mut self)

Reset / clear all recorded events.

pub fn total_time(&self) -> Duration

Total wall-clock time across all events.

pub fn report(&self) -> ProfileReport

Generate a human-readable ProfileReport.

Trait Implementations

impl Default for Profiler

fn default() -> Self

Returns the “default value” for a type.