Struct CompilerIr 

pub struct CompilerIr {

    pub schema_version: String,
    pub unit: UnitRef,
    pub anchored_at: Option<String>,
    pub symbols: Vec<ResolvedSymbol>,
    pub types: Vec<ResolvedType>,
    pub calls: Vec<CallSite>,
    pub semantic_constructs: Vec<SemanticConstruct>,
    pub expressions: Vec<ResolvedExpression>,
    pub unexpanded_macros: Vec<UnexpandedMacro>,
    pub cfg: Option<ControlFlowGraph>,
    pub instantiations: Vec<Instantiation>,
    pub effects: EffectSummary,
    pub data_flow: DataFlowSummary,
}

Everything one helper found in one unit.

Fields

schema_version: String

The schema this was written against.

unit: UnitRef

What it is about.

anchored_at: Option<String>

The directory the file paths in this analysis are spelled against.

A helper reports paths the way the project spells them, which is relative to the root it read the project from — not to whatever directory a scan was started in. Saying which root that was is what lets a reader turn a file it knows about into the name this analysis filed it under. Without it the two spellings can only be compared by hoping they agree, and comparing on a shared suffix instead would let one file’s answers be counted for another’s, since two files can end the same way.

None when the paths stand on their own, which is what an analysis with no project root to speak of reports.

symbols: Vec<ResolvedSymbol>

Names resolved to definitions.

types: Vec<ResolvedType>

Types, referred to by index from everything else.

calls: Vec<CallSite>

Calls and what they call.

semantic_constructs: Vec<SemanticConstruct>

Compiler-confirmed constructs available to restricted semantic rules.

expressions: Vec<ResolvedExpression>

Expression types whose anchor may cover an invocation rather than one source token.

unexpanded_macros: Vec<UnexpandedMacro>

Macro invocations that were not expanded, and why.

cfg: Option<ControlFlowGraph>

Control flow, when the helper offers it.

instantiations: Vec<Instantiation>

Generic and template instantiations.

effects: EffectSummary

What the unit does. Declared, not yet computed.

data_flow: DataFlowSummary

How values move. Declared, not yet computed.

Implementations

impl CompilerIr

pub fn empty(unit: UnitRef) -> Self

An empty result for unit, written against this build’s schema.

pub fn is_readable(&self) -> bool

Whether this was written against a schema this build reads.

pub fn spelling(&self, absolute: &Path) -> String

How this analysis spells absolute, so a caller holding a file can look up what was said about it.

Trait Implementations

impl Clone for CompilerIr

fn clone(&self) -> CompilerIr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompilerIr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompilerIr

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CompilerIr

impl PartialEq for CompilerIr

fn eq(&self, other: &CompilerIr) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CompilerIr

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CompilerIr