Struct CallString

pub struct CallString(Intern<Box<[GlobalLocation]>>);

A location within the global call-graph.

The first location is the root of the call-graph. The last location is the currently-called function.

Invariant: a call string should never be empty, i.e., there should always be at least one GlobalLocation in a call-string.

Note: This type is copyable due to interning.

Tuple Fields

0: Intern<Box<[GlobalLocation]>>

Implementations

impl CallString

pub fn pop(self) -> (GlobalLocation, Option<CallString>)

Split the leaf (the current instruction) from the caller for the function (if any) and return both. Same as (self.leaf(), self.caller()).

pub fn single(loc: GlobalLocation) -> CallString

Create an initial call string for the single location loc.

pub fn leaf(self) -> GlobalLocation

Returns the leaf of the call string (the currently-called function).

pub fn caller(self) -> Option<CallString>

Returns the call string minus the leaf. Returns None if this location is at the root.

pub fn iter(&self) -> impl DoubleEndedIterator

Returns an iterator over the locations in the call string, starting at the leaf and going to the root.

pub fn push(self, loc: GlobalLocation) -> CallString

Adds a new call site to the end of the call string.

pub fn push_front(self, loc: GlobalLocation) -> CallString

pub fn is_at_root(self) -> bool

pub fn root(self) -> GlobalLocation

pub fn stable_id(self) -> usize

pub fn iter_from_root(&self) -> impl DoubleEndedIterator

Returns an iterator over the locations in the call string, starting at the root and going to the leaf.

pub fn len(self) -> usize

pub fn is_empty(self) -> bool

Trait Implementations

impl Clone for CallString

fn clone(&self) -> CallString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallString

fn deserialize<__D>( __deserializer: __D, ) -> Result<CallString, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CallString

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

Formats the value using the given formatter.

impl<'a> GraphWalk<'a, CallString, GlobalEdge> for DotPrintableProgramDescription<'_>

fn nodes(&'a self) -> Nodes<'a, CallString>

Returns all the nodes in this graph.

fn edges(&'a self) -> Edges<'a, GlobalEdge>

Returns all of the edges in this graph.

fn source(&'a self, edge: &GlobalEdge) -> CallString

The source node for edge.

fn target(&'a self, edge: &GlobalEdge) -> CallString

The target node for edge.

impl Hash for CallString

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Labeller<'a, CallString, GlobalEdge> for DotPrintableProgramDescription<'_>

fn graph_id(&'a self) -> Id<'a>

Must return a DOT compatible identifier naming the graph.

fn node_id(&'a self, n: &CallString) -> Id<'a>

Maps n to a unique identifier with respect to self. The implementer is responsible for ensuring that the returned name is a valid DOT identifier.

fn node_shape(&'a self, _node: &CallString) -> Option<LabelText<'a>>

Maps n to one of the graphviz shape names. If None is returned, no shape attribute is specified.

fn node_label(&'a self, n: &CallString) -> LabelText<'a>

Maps n to a label that will be used in the rendered output. The label need not be unique, and may be the empty string; the default is just the output from node_id.

fn edge_color(&'a self, e: &GlobalEdge) -> Option<LabelText<'a>>

Maps e to one of the graphviz color names. If None is returned, no color attribute is specified.

fn source_port_position( &'a self, edge: &GlobalEdge, ) -> (Option<Id<'a>>, Option<CompassPoint>)

Specify a subpart of the source node for the origin of the edge (portname) and a direction for the edge (compass_point). See also https://graphviz.org/docs/attr-types/portPos/.

fn target_port_position( &'a self, edge: &GlobalEdge, ) -> (Option<Id<'a>>, Option<CompassPoint>)

Same as source_port_position but for the target end of the edge.

fn edge_label(&'a self, e: &E) -> LabelText<'a>

Maps e to a label that will be used in the rendered output. The label need not be unique, and may be the empty string; the default is in fact the empty string.

fn node_style(&'a self, _n: &N) -> Style

Maps n to a style that will be used in the rendered output.

fn rank_dir(&'a self) -> Option<RankDir>

Return an explicit rank dir to use for directed graphs.

fn node_color(&'a self, _node: &N) -> Option<LabelText<'a>>

Maps n to one of the graphviz color names. If None is returned, no color attribute is specified.

fn edge_end_arrow(&'a self, _e: &E) -> Arrow

Maps e to arrow style that will be used on the end of an edge. Defaults to default arrow style.

fn edge_start_arrow(&'a self, _e: &E) -> Arrow

Maps e to arrow style that will be used on the end of an edge. Defaults to default arrow style.

fn edge_style(&'a self, _e: &E) -> Style

Maps e to a style that will be used in the rendered output.

fn kind(&self) -> Kind

The kind of graph, defaults to Kind::Digraph.

impl PartialEq for CallString

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CallString

impl Eq for CallString

impl StructuralPartialEq for CallString