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

fn new(locs: Box<[GlobalLocation]>) -> Self

Create a new call string from a list of global locations.

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) -> Self

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<Self>

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

pub fn iter(&self) -> impl DoubleEndedIterator<Item = GlobalLocation> + '_

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) -> Self

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

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

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<Item = GlobalLocation> + '_

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CallString

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

Formats the value using the given formatter.

impl Hash for CallString

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

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 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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CallString

impl Eq for CallString

impl StructuralPartialEq for CallString