Struct Summary 

pub struct Summary { /* private fields */ }

What a function does to memory.

Implementations

impl Summary

pub fn nothing(arity: usize) -> Self

A function that touches no memory at all, taking this many parameters.

pub fn everything(arity: usize) -> Self

A function nothing is known about, taking this many parameters.

pub fn outside(&self) -> Effect

What it does to memory it was not handed: the globals, and anything reached through an address that did not arrive as an argument.

pub fn param(&self, index: usize) -> Touch

What it does to the object the parameter in this position points at.

A position past the end is an argument no parameter stands for, which is a variadic call, and the answer for one of those is that anything may have happened to it.

pub fn arity(&self) -> usize

How many parameters it has an answer for.

pub fn only_through_arguments(&self) -> bool

Whether everything it touches, it reached through an argument.

This is __attribute__((access))’s promise and the IR’s argmemonly, worked out rather than declared, and it is what lets crate::alias ask about the arguments one at a time instead of giving up.

pub fn writes_nothing(&self) -> bool

Whether it writes nothing anywhere, which is readonly worked out rather than declared.

pub fn touches_nothing(&self) -> bool

Whether it touches nothing anywhere, which is readnone.

Trait Implementations

impl Clone for Summary

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 Summary

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

Formats the value using the given formatter.

impl Eq for Summary

impl PartialEq for Summary

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Summary