Struct RootTree

pub struct RootTree { /* private fields */ }

Available on crate feature runner only.

A Tree without any leafs. Useful if only the root data and metrics are of interest.

If you’re just interested in the data of the root then it is more performant to use this tree instead of building a complete DhatTree. The dhat metrics of the root are the summarized metrics of all its children, so all this Tree does is summarizing the metrics without actually building the tree.

Trait Implementations

impl Clone for RootTree

fn clone(&self) -> RootTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RootTree

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

Formats the value using the given formatter.

impl Default for RootTree

fn default() -> RootTree

Returns the “default value” for a type.

impl PartialEq for RootTree

fn eq(&self, other: &RootTree) -> 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 Tree for RootTree

fn insert(&mut self, _prefix: &[usize], data: &Data)

Insert a prefix with the given Data into this Tree

fn set_root_data(&mut self, data: Data)

Set the Data of the root

fn get_root_data(&self) -> &Data

Return the Data of the root

fn mode(&self) -> Mode

Return the dhat invocation Mode

fn set_mode(&mut self, mode: Mode)

Set the dhat invocation Mode

fn from_json( dhat_data: DhatData, entry_point: &EntryPoint, frames: &[Glob], ) -> Self

where Self: Sized + Default,

Create a new Tree from the given parameters

fn insert_iter(&mut self, iter: impl Iterator<Item = ProgramPoint>)

Insert all ProgramPoints into this Tree

fn metrics(&self) -> ToolMetrics

Return the metrics of the root node

impl Eq for RootTree

impl StructuralPartialEq for RootTree