Struct CompileCommands 

pub struct CompileCommands {
    pub entries: Vec<CompileEntry>,
    pub content_hash: Option<String>,
}

A parsed compilation database with duplicate translation units removed.

Fields

entries: Vec<CompileEntry>

Distinct translation units, in the order first seen.

content_hash: Option<String>

A hash of the document this was read from, retained as provenance.

Per-entry build identities use normalized compiler settings instead; this database-wide value would make an unrelated added translation unit invalidate every existing partition.

Implementations

impl CompileCommands

pub fn read(path: &Path) -> Result<Self, CompileCommandsError>

Read and parse a compile_commands.json file at path.

Errors

Returns CompileCommandsError if the file cannot be read or is not a JSON array of { "file": ..., "directory": ... } objects.

pub fn read_with_limit( path: &Path, max_bytes: u64, ) -> Result<Self, CompileCommandsError>

Read and parse a compilation database after enforcing max_bytes.

Errors

Returns CompileCommandsError::TooLarge before reading an oversized file, or the same failures as Self::read for an otherwise readable file.

pub fn translation_unit_count(&self) -> usize

Number of distinct translation units.

pub fn source_file_count(&self) -> usize

Number of distinct source files across those translation units.

Lower than Self::translation_unit_count wherever a file is compiled more than one way, which is the case the fragment side has to avoid registering twice.

pub fn build_partitions(&self) -> BTreeMap<String, Vec<&CompileEntry>>

Group entries by the C/C++ build configuration they describe.

A partition contains every command with identical semantic settings; source paths deliberately do not participate in its identity. That lets two ordinary translation units share one scan while keeping a duplicated source with different -D settings in separate partitions.

Trait Implementations

impl Clone for CompileCommands

fn clone(&self) -> CompileCommands

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompileCommands

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

Formats the value using the given formatter.

impl Default for CompileCommands

fn default() -> CompileCommands

Returns the “default value” for a type.