Struct trace_tools::util::Flamegrapher

pub struct Flamegrapher { /* private fields */ }

Helper struct that uses inferno internally to programatically produce a flamegraph from a folded stack trace file.

Implementations

impl Flamegrapher

pub fn new() -> Self

Creates a new Flamegrapher with no associated files.

pub fn with_stack_file<P: AsRef<Path>>(
    self,
    stack_filename: P
) -> Result<Self, Error>

Returns a Flamegrapher with the given folded stack file name.

Errors

This method may fail in the following ways:

• The given stack file does not exist.

pub fn with_graph_file<P: AsRef<Path>>(
    self,
    graph_filename: P
) -> Result<Self, Error>

Returns a Flamegrapher with the given flamegraph file name.

This file will be given the extension of .svg.

Errors

This method may fail in the following ways:

• The given graph filename is invalid (it does not belong to a directory that exists).

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

Uses inferno to generate a flamegraph from the given folded stack file, and writes it to the given output image file.

Errors

This method may fail in the following ways:

• This Flamegrapher does not have a stack or graph file associated with it.
• An error was encountered when opening the folded stack file for reading.
• An error was encountered when creating the graph file.

Trait Implementations

impl Default for Flamegrapher

fn default() -> Flamegrapher

Returns the “default value” for a type.