Struct borrow_graph::graph::BorrowGraph

pub struct BorrowGraph<Loc: Copy, Lbl: Clone + Ord>(_);

Implementations

impl<Loc: Copy, Lbl: Clone + Ord> BorrowGraph<Loc, Lbl>

pub fn new() -> Self

creates an empty borrow graph

pub fn is_mutable(&self, id: RefID) -> bool

checks if the given reference is mutable or not

pub fn new_ref(&mut self, id: RefID, mutable: bool)

Adds a new reference to the borrow graph Fails if the id is already in use

pub fn borrowed_by( &self, id: RefID ) -> (BTreeMap<RefID, Loc>, BTreeMap<Lbl, BTreeMap<RefID, Loc>>)

Return the references borrowing the id reference The borrows are collected by first label in the borrow edge BTreeMap<RefID, Loc> represents all of the “full” or “epsilon” borrows (non field borrows) BTreeMap<Lbl, BTreeMap<RefID, Loc>>) represents the field borrows, collected over the first label

pub fn between_edges( &self, parent: RefID, child: RefID ) -> Vec<(Loc, Vec<Lbl>, bool)>

Return the edges between parent and child

pub fn out_edges(&self, id: RefID) -> Vec<(Loc, Vec<Lbl>, bool, RefID)>

Return the outgoing edges from id

pub fn in_edges(&self, id: RefID) -> Vec<(Loc, RefID, Vec<Lbl>, bool)>

Return the incoming edges into id

pub fn add_strong_borrow(&mut self, loc: Loc, parent_id: RefID, child_id: RefID)

Add a strong (exact) epsilon borrow from parent_id to child_id

pub fn add_strong_field_borrow( &mut self, loc: Loc, parent_id: RefID, field: Lbl, child_id: RefID )

Add a strong (exact) field borrow from parent_id to child_id at field field

pub fn add_weak_borrow(&mut self, loc: Loc, parent_id: RefID, child_id: RefID)

Add a weak (prefix) epsilon borrow from parent_id to child_id i.e. child_id might be borrowing from ANY field in parent_id

pub fn add_weak_field_borrow( &mut self, loc: Loc, parent_id: RefID, field: Lbl, child_id: RefID )

Add a weak (prefix) field borrow from parent_id to child_id at field field i.e. child_id might be borrowing from ANY field in parent_id rooted at field

pub fn release(&mut self, id: RefID)

Remove reference id from the graph Fixes any transitive borrows, so if parent borrowed by id borrowed by child After the release, parent borrowed by child

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

checks if self covers other

pub fn remap_refs(&mut self, id_map: &BTreeMap<RefID, RefID>)

Utility for remapping the reference ids according the id_map provided If it is not in the map, the id remains the same

pub fn join(&self, other: &Self) -> Self

Joins other into self It adds only ‘unmatched’ edges from other into self, i.e. for any edge in other, if there is an edge in self that is <= than that edge, it is not added.

pub fn contains_id(&self, ref_id: RefID) -> bool

Checks if the current reference is in the graph

pub fn all_refs(&self) -> BTreeSet<RefID>

Returns all ref ids in the map

pub fn display(&self)where Lbl: Display,

Prints out a view of the borrow graph

Trait Implementations

impl<Loc: Clone + Copy, Lbl: Clone + Clone + Ord> Clone for BorrowGraph<Loc, Lbl>

fn clone(&self) -> BorrowGraph<Loc, Lbl>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Loc: Debug + Copy, Lbl: Debug + Clone + Ord> Debug for BorrowGraph<Loc, Lbl>

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

Formats the value using the given formatter.

impl<Loc: Default + Copy, Lbl: Default + Clone + Ord> Default for BorrowGraph<Loc, Lbl>

fn default() -> BorrowGraph<Loc, Lbl>

Returns the “default value” for a type.

impl<Loc: PartialEq + Copy, Lbl: PartialEq + Clone + Ord> PartialEq<BorrowGraph<Loc, Lbl>> for BorrowGraph<Loc, Lbl>

fn eq(&self, other: &BorrowGraph<Loc, Lbl>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Loc: Eq + Copy, Lbl: Eq + Clone + Ord> Eq for BorrowGraph<Loc, Lbl>

impl<Loc: Copy, Lbl: Clone + Ord> StructuralEq for BorrowGraph<Loc, Lbl>

impl<Loc: Copy, Lbl: Clone + Ord> StructuralPartialEq for BorrowGraph<Loc, Lbl>