Struct FlameGraphBuilder

pub struct FlameGraphBuilder { /* private fields */ }

Build a flamegraph from given root objects.

Example

use allocative::Allocative;
use allocative::FlameGraphBuilder;

#[derive(Allocative)]
struct Foo {
    data: String,
};

let foo1 = Foo {
    data: "Hello, world!".to_owned(),
};
let foo2 = Foo {
    data: "Another message!".to_owned(),
};

let mut flamegraph = FlameGraphBuilder::default();
flamegraph.visit_root(&foo1);
flamegraph.visit_root(&foo2);
let flamegraph_src = flamegraph.finish().flamegraph();

And now flamegraph_src can be fed to either flamegraph.pl or inferno.

Implementations

impl FlameGraphBuilder

pub fn root_visitor(&mut self) -> Visitor<'_>

pub fn visit_root(&mut self, root: &dyn Allocative)

Collect tree sizes starting from given root.

pub fn visit_global_roots(&mut self)

Collect data from global roots registered with register_root.

pub fn finish(self) -> FlameGraphOutput

Finish building the flamegraph.

pub fn finish_and_write_flame_graph(self) -> String

Finish building the flamegraph and return the flamegraph output.

Trait Implementations

impl Debug for FlameGraphBuilder

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

Formats the value using the given formatter.

impl Default for FlameGraphBuilder

fn default() -> FlameGraphBuilder

Returns the “default value” for a type.