Struct ProjectOverview 

pub struct ProjectOverview {
    pub content: String,
    pub path: PathBuf,
}

Project overview containing the generated summary.

Fields

content: String

The rendered markdown content.

path: PathBuf

Path to the overview file (for cache invalidation info).

Implementations

impl ProjectOverview

pub fn load(project_root: &Path) -> Result<Option<Self>>

Load the overview from the project root if it exists. Returns None if the file doesn’t exist.

pub async fn generate_with_ai( project_root: &Path, provider: &dyn Provider, ) -> Result<Self>

Generate and save a new overview using AI analysis. This method collects project files and sends them to the AI for analysis.

pub fn clear(project_root: &Path) -> Result<()>

Delete the overview file if it exists.

pub fn exists(project_root: &Path) -> bool

Check if an overview exists for the project.

pub fn path(project_root: &Path) -> PathBuf

Get the path to the overview file.

Trait Implementations

impl Clone for ProjectOverview

fn clone(&self) -> ProjectOverview

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectOverview

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

Formats the value using the given formatter.