Struct ProjectData 

pub struct ProjectData {
    pub name: String,
    pub platform_id: Option<String>,
    pub language: SourceLanguage,
    pub content: ProjectScopeContent,
}

A project, as the higher-level pipeline sees it.

name is the canonical identifier the database uses, platform_id is the optional outside-world handle (e.g. c4-455), language tells downstream agents which extractor to dispatch to, and content is the already-read source corpus the scope walker produced.

Fields

name: String

platform_id: Option<String>

language: SourceLanguage

content: ProjectScopeContent

Implementations

impl ProjectData

pub fn new( name: String, platform_id: Option<String>, language: SourceLanguage, content: ProjectScopeContent, ) -> Self

pub fn display_id(&self) -> &str

Display-friendly identifier: platform_id if set, otherwise name. Used for log lines and progress reporting.

pub fn repo_root(&self) -> &Path

Repo root resolved by the scope walker. Always absolute and canonicalised because the underlying ProjectScope::build canonicalises before walking.

pub fn source_files(&self) -> &[ScopedSourceFile]

In-scope source files with content. The slice order matches the BTreeSet<PathBuf> order of the ProjectScope this project was built from.

pub async fn from_source_dir_spec(spec: &str) -> Result<Self>

Parse a name:path / name:path:platform_id spec and load the project, auto-detecting Solidity vs Move based on which extension is present under path. Errors when both are present (we don’t support mixed-language projects) or when neither is.

pub async fn from_path_spec(spec: &str) -> Result<Self>

Parse a name:path / name:path:platform_id spec and load the project, forcing Solidity (no auto-detect). Faster than Self::from_source_dir_spec when you already know the project is Solidity because it only walks for .sol files.

pub async fn from_dir( name: &str, root_dir: &Path, platform_id: Option<&str>, ) -> Result<Self>

Load a Solidity project from root_dir. Walks the tree with the default vendored-dir blocklist (node_modules, lib, build, artifacts, cache, coverage, .git, target, typechain*).

pub async fn from_source_dir( name: &str, root_dir: &Path, platform_id: Option<&str>, ) -> Result<Self>

Load a project from root_dir, auto-detecting language by walking once per supported language and choosing the one that produced any files.

pub async fn from_move_snapshot( name: &str, root_dir: &Path, commit_hash: &str, ) -> Result<Self>

Load a Move project snapshot. Walks for **/*.move, applies the standard vendored-dir blocklist, and tags platform_id as b-<commit_hash> to match the existing C4-style scheme.

pub async fn from_relative_paths( name: &str, root_dir: &Path, language: SourceLanguage, platform_id: Option<&str>, relative_paths: &[PathBuf], ) -> Result<Self>

Build a project from an explicit list of repo-relative paths, skipping the ProjectScope::build_from_patterns walk. Useful when the source set has already been filtered upstream — e.g. by scope.txt + glob filters in the static Solidity pipeline — so we just want to read those exact files and wrap them in a ProjectData. The paths are joined onto a canonicalised root_dir; each file is loaded sequentially via tokio::fs::read_to_string.

Trait Implementations

impl Clone for ProjectData

fn clone(&self) -> ProjectData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectData

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

Formats the value using the given formatter.