cordx56/rustowl
Rustowl
Rustowl is a diagnostic system and language server protocol extension that maps variable validity and data flow directly into text editors. It serves as a memory management tool designed to visualize lifetime constraints and ownership movement within Rust source code.
The project distinguishes itself by providing a visual representation of immutable borrowings, mutable borrowings, and value moves. It specifically tracks the duration of variable validity and identifies invalid overlapping references or lifetime mismatches to assist in memory debugging.
The system employs static analysis to track data flow and calculate lifetime intervals. This analysis is streamed to the editor as metadata, allowing for the rendering of non-textual UI overlays and diagnostic markers that illustrate how values move through a program.
Features
- Lifetime Visualizations - Maps the duration and state of variables directly in the editor to simplify debugging of complex Rust lifetime constraints.
- LSP Client Extensions - Implements a mechanism to extend the Language Server Protocol for rendering custom memory visualization UI elements in text editors.
- LSP Clients - Extends the LSP client logic to process and render specialized visualization data for memory management.
- Memory Ownership Debuggers - Visualizes ownership and borrowing patterns to identify and fix memory management errors in Rust code.
- Ownership & Borrowing - Analyzes source code to track ownership transfers and distinguish between mutable and immutable borrowing patterns.
- Ownership Transition Tracking - Highlights immutable borrowings, mutable borrowings, and value moves to visualize data flow through an application.
- Ownership Visualization Interfaces - Provides a visual representation of immutable borrowings, mutable borrowings, and value moves to simplify memory debugging.
- Visual Lifetime Tooling - Renders visual indicators of variable lifetimes and ownership movement within text editors via an LSP extension.
- Lifetime Interval Mapping - Calculates the start and end points of variable validity to determine overlapping reference durations.
- Memory Management Diagnostics - Identifies invalid overlapping references and lifetime mismatches in Rust source code using static analysis.
- Ownership Flow Visualizations - Models and visualizes the movement of values between variables to illustrate ownership transitions and memory lifecycles.
- Lifetime State Visualizers - Maps the duration a variable remains valid and its initialization state using visual indicators in the editor.
- Value and Lifetime Analysis - Identifies invalid overlapping references or mismatches between actual and expected lifetimes to simplify memory debugging.
- LSP Visualization Overlays - Extends the Language Server Protocol to send metadata for rendering non-textual UI overlays of memory constraints.
- Real-Time Code Diagnostics - Provides immediate visual feedback on variable lifetimes and ownership results as diagnostic markers during the editing process.
- Static Analysis Tools - Uses static analysis to track how values move and are borrowed throughout a program to understand data flow.
- Data Flow Visualizations - Maps the duration of variable validity and data flow directly into the developer's IDE.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
