Struct FullCallGraph

Source
pub struct FullCallGraph { /* private fields */ }
Expand description

Full call graph including execution time and number of calls between functions/spans.

This graph is a directed graph linking different SpanTiming by the number of time a given span was the child of another one.

§Examples

Code that looks like this

#[time_graph::instrument]
fn start() {
    inside();
    inside();
    inner();
}

#[time_graph::instrument]
fn inside() {
   inner();
}

#[time_graph::instrument]
fn inner() {
    // do stuff
}

Will result in a graph like this, where the number near the edge correspond to the number of time a given span called another one.

            | start, called 1 |
               /           |
             /  2          |
           /               |  1
  | inside, called 2 |     |
                \          |
                2 \        |
                    \      |
                 | inner, called 3 |

Implementations§

Source§

impl FullCallGraph

Source

pub fn spans(&self) -> impl Iterator<Item = &TimedSpan>

Get the full list of spans/functions known by this graph

Source

pub fn calls(&self) -> impl Iterator<Item = Calls> + '_

Get the list of calls between spans in this graph

Source

pub fn as_dot(&self) -> String

Get the full graph in graphviz dot format.

The exact output is unstable and should not be relied on.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.