Struct Project

pub struct Project {
    pub kind: ProjectType,
    pub root_path: PathBuf,
    pub build_arts: BuildArtifacts,
    pub name: Option<String>,
}

Representation of a development project with cleanable build artifacts.

This struct encapsulates all information about a development project, including its type, location, build artifacts, and metadata extracted from project configuration files.

Fields

kind: ProjectType

Type of the project (Rust or Node.js)

root_path: PathBuf

The root directory of the project where the configuration file is located

For Rust projects, this is the directory containing Cargo.toml. For Node.js projects, this is the directory containing package.json.

build_arts: BuildArtifacts

The build directory to be cleaned and its metadata

Contains information about the target/ or node_modules/ directory that is a candidate for cleanup, including its path and total size.

name: Option<String>

Name of the project extracted from configuration files

For Rust projects, this is extracted from the name field in Cargo.toml. For Node.js projects, this is extracted from the name field in package.json. May be None if the name cannot be determined or parsed.

Implementations

impl Project

pub fn new( kind: ProjectType, root_path: PathBuf, build_arts: BuildArtifacts, name: Option<String>, ) -> Self

Create a new project instance.

This constructor creates a new Project with the specified parameters. It’s typically used by the scanner when a valid development project is detected in the file system.

Arguments

• kind - The type of project (Rust or Node.js)
• root_path - Path to the project’s root directory
• build_arts - Information about the build artifacts to be cleaned
• name - Optional project name extracted from configuration files

Returns

A new Project instance with the specified parameters.

Examples

let build_arts = BuildArtifacts {
    path: PathBuf::from("/path/to/project/target"),
    size: 1024,
};

let project = Project::new(
    ProjectType::Rust,
    PathBuf::from("/path/to/project"),
    build_arts,
    Some("my-project".to_string()),
);

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Project

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

Format the project for display with the appropriate emoji and name.

This implementation provides a human-readable representation of the project that includes:

• An emoji indicator based on the project type (🦀 for Rust, 📦 for Node.js, 🐍 for Python, 🐹 for Go)
• The project name if available, otherwise just the path
• The project’s root path

Examples

• 🦀 my-rust-project (/path/to/project)
• 📦 my-node-app (/path/to/app)
• 🐍 my-python-project (/path/to/project)
• 🐹 my-go-project (/path/to/project)
• 🦀 /path/to/unnamed/project (when no name is available)