Struct Profile 

pub struct Profile { /* private fields */ }

The Profile structure stores how long it takes to do a task.

Examples

use std::{time::Duration, thread::sleep};
use xuko_misc::profiling::Profile;

let mut profile = Profile::new("sleep");
sleep(Duration::from_millis(100));

let elapsed = profile.elapsed().unwrap();
assert!(elapsed >= 100);

sleep(Duration::from_millis(100));
// the result is saved!
assert_eq!(profile.elapsed().unwrap(), elapsed);

Implementations

impl Profile

pub fn new<S: AsRef<str>>(name: S) -> Self

Create a new Profile

pub fn elapsed(&mut self) -> Result<u128, SystemTimeError>

Same as Self::elapsed_duration, except maps the result with Duration::as_millis

pub fn elapsed_duration(&mut self) -> Result<Duration, SystemTimeError>

Return how much time has passed since the start of this Profile as a Duration

This can only fail once, as the result will be saved in the Profile structure.

pub fn name(&self) -> &str

Get the name of this Profile