Struct Profiler

pub struct Profiler { /* private fields */ }

The Profiler

The Profiler gives access to the gperftools library. By storing the state of the profiler and limiting access we make the FFI safer.

Implementations

impl Profiler

pub fn state(&self) -> ProfilerState

Returns the profiler state

Examples

use gperftools::profiler::PROFILER;

println!("{}", PROFILER.lock().unwrap().state());

pub fn start<T>(&mut self, fname: T) -> Result<(), Error>

where T: Into<Vec<u8>>,

Start the profiler

Will begin sampling once this function has been called and will not stop until the stop function has been called.

This function takes as an argument a filename. The filename must be both valid Utf8 and a valid CString.

Failures

• The profiler is currently Active.
• fname is not a valid CString.
• fname is not valid Utf8.
• fname is not a file.
• The user does not have write access to the file.
• An internal failure from the gperftools library.

Examples found in repository

examples/primes.rs (line 47)

fn main() {
    let prime_numbers = prepare_prime_numbers();

    gperftools_static::PROFILER
        .lock()
        .unwrap()
        .start("/tmp/prime.target")
        .unwrap();

    let mut v = 0;
    for i in 2..50000 {
        if is_prime_number(i, &prime_numbers) {
            v += 1;
        }
    }

    gperftools_static::PROFILER.lock().unwrap().stop().unwrap();

    println!("Prime numbers: {}", v);
}

pub fn stop(&mut self) -> Result<(), Error>

Stop the profiler.

This will stop the profiler if it Active and return an error otherwise.

Failures

• The profiler is NotActive.

Examples found in repository

examples/primes.rs (line 57)

fn main() {
    let prime_numbers = prepare_prime_numbers();

    gperftools_static::PROFILER
        .lock()
        .unwrap()
        .start("/tmp/prime.target")
        .unwrap();

    let mut v = 0;
    for i in 2..50000 {
        if is_prime_number(i, &prime_numbers) {
            v += 1;
        }
    }

    gperftools_static::PROFILER.lock().unwrap().stop().unwrap();

    println!("Prime numbers: {}", v);
}

Trait Implementations

impl Debug for Profiler

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

Formats the value using the given formatter.