Skip to main content

BorrowAnalysis

shape_vm::mir::analysis

Struct BorrowAnalysis 

Source 
pub struct BorrowAnalysis {
    pub liveness: LivenessResult,
    pub loans_at_point: HashMap<Point, Vec<LoanId>>,
    pub loans: HashMap<LoanId, LoanInfo>,
    pub errors: Vec<BorrowError>,
    pub ownership_decisions: HashMap<Point, OwnershipDecision>,
    pub mutability_errors: Vec<MutabilityError>,
    pub return_reference_summary: Option<ReturnReferenceSummary>,
}
Expand description

The complete borrow analysis for a single function. Produced by the Datafrog solver + liveness analysis. Consumed (read-only) by compiler, LSP, and diagnostics.

Fields§

§liveness: LivenessResult

Liveness results for move/clone decisions.

§loans_at_point: HashMap<Point, Vec<LoanId>>

Active loans at each program point (from Datafrog solver).

§loans: HashMap<LoanId, LoanInfo>

Loan metadata.

§errors: Vec<BorrowError>

Borrow errors detected by the solver.

§ownership_decisions: HashMap<Point, OwnershipDecision>

Move/clone decisions for each assignment of a non-Copy type.

§mutability_errors: Vec<MutabilityError>

Immutability violations (writing to immutable bindings).

§return_reference_summary: Option<ReturnReferenceSummary>

If this function safely returns one reference parameter (possibly with a projection), records which parameter flows out and whether it is shared/exclusive.

Implementations§

Source§

impl BorrowAnalysis

Source

pub fn empty() -> Self

Create an empty analysis (used as default before solver runs).

Source

pub fn has_errors(&self) -> bool

Check if the analysis found any errors.

Source

pub fn ownership_at(&self, point: Point) -> OwnershipDecision

Get the ownership decision for a given point. Returns Copy for primitive types.

Source

pub fn active_loans_at(&self, point: Point) -> &[LoanId]

Get all active loans at a given point (for LSP borrow windows).

Source

pub fn loan(&self, id: LoanId) -> Option<&LoanInfo>

Get loan info by ID.

Trait Implementations§

Source§

impl Debug for BorrowAnalysis

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,