Struct FlamegraphProfile 

pub struct FlamegraphProfile { /* private fields */ }

A collected VM cycle profile that can be rendered as folded stacks or an SVG flamegraph.

Implementations

impl FlamegraphProfile

pub fn collect(executor: &mut DebugExecutor) -> Result<Self, ExecutionError>

Execute executor to completion, sampling its call stack for every VM cycle.

pub fn record_call_stack(&mut self, frames: &[CallFrame], cycles: usize)

Record cycles against a call stack from the debugger engine.

pub fn record_stack<I, S>(&mut self, frames: I, cycles: usize)

where I: IntoIterator<Item = S>, S: AsRef<str>,

Record cycles against a stack of frame names.

Frame names are sanitized for folded stack output, then joined with ;.

pub fn record_stack_path( &mut self, stack_path: impl Into<String>, cycles: usize, )

Record cycles against an already formatted folded-stack path.

pub fn samples(&self) -> &Samples

pub fn total_cycles(&self) -> usize

pub fn unique_stack_paths(&self) -> usize

pub fn write_to_path( &self, path: impl AsRef<Path>, ) -> Result<FlamegraphOutput, Report>

Write this profile as an SVG when path ends in .svg, otherwise as folded stack text.

pub fn write_folded_stacks(&self, path: impl AsRef<Path>) -> Result<(), Report>

Write this profile in folded stack format.

pub fn write_svg(&self, path: impl AsRef<Path>) -> Result<(), Report>

Render this profile as an SVG flamegraph.

Trait Implementations

impl Clone for FlamegraphProfile

fn clone(&self) -> FlamegraphProfile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FlamegraphProfile

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

Formats the value using the given formatter.

impl Default for FlamegraphProfile

fn default() -> FlamegraphProfile

Returns the “default value” for a type.

impl PartialEq for FlamegraphProfile

fn eq(&self, other: &FlamegraphProfile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FlamegraphProfile

impl StructuralPartialEq for FlamegraphProfile