Struct Summaries 

pub struct Summaries { /* private fields */ }

What is known about each function in the module.

Built once, because a summary belongs to the callee and there is one callee and many call sites. A pass holding one function and no module has Summaries::nothing, which answers None to everything and leaves every caller with the conservative answer.

Implementations

impl Summaries

pub fn nothing() -> Self

Nothing known about anything.

pub fn of_module(module: &Module) -> Self

What the attributes on each of the module’s functions promise, before anything is read.

The three that say something about memory are the three crate::alias already reads, and what they promise is the floor the analysis starts from rather than something it can contradict. A function with none of them gets no entry, which is not the same as an entry saying it does everything: the difference is what lets summarize tell a promise it has to keep from an absence it may fill in.

pub fn of(&self, name: Symbol) -> Option<&Summary>

What is known about this function, or nothing.

pub fn at(&self, func: &Func, call: Inst) -> Option<&Summary>

What is known about what this call reaches.

Only a direct call has an answer. A call through an address, inline assembly and a target intrinsic are all names this cannot put to a body.

pub fn record(&mut self, name: Symbol, summary: Summary)

Writes down what the analysis worked out.

Narrowed against whatever the attributes promised rather than written over it, because a promise the body does not keep is still a promise the caller was told to rely on, and the build that reports the function whose attribute was a lie wants both halves.

pub fn len(&self) -> usize

How many functions there is an answer for.

pub fn is_empty(&self) -> bool

Whether nothing is known about anything.

Trait Implementations

impl Clone for Summaries

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Summaries

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

Formats the value using the given formatter.

impl Default for Summaries

fn default() -> Self

Returns the “default value” for a type.