Struct CodebaseMetadata

pub struct CodebaseMetadata {
    pub infer_types_from_usage: bool,
    pub aliases: HashMap<StringIdentifier, TypeMetadata>,
    pub class_likes: HashMap<StringIdentifier, ClassLikeMetadata>,
    pub function_likes: HashMap<(StringIdentifier, StringIdentifier), FunctionLikeMetadata>,
    pub symbols: Symbols,
    pub constants: HashMap<StringIdentifier, ConstantMetadata>,
    pub all_class_like_descendants: HashMap<StringIdentifier, HashSet<StringIdentifier>>,
    pub direct_classlike_descendants: HashMap<StringIdentifier, HashSet<StringIdentifier>>,
    pub safe_symbols: HashSet<StringIdentifier>,
    pub safe_symbol_members: HashSet<(StringIdentifier, StringIdentifier)>,
}

Holds all analyzed information about the symbols, structures, and relationships within a codebase.

This acts as the central repository for metadata gathered during static analysis, including details about classes, interfaces, traits, enums, functions, constants, their members, inheritance, dependencies, and associated types.

Fields

infer_types_from_usage: bool

Configuration flag: Should types be inferred based on usage patterns?

aliases: HashMap<StringIdentifier, TypeMetadata>

Map from type alias name (StringIdentifier) to its metadata (TypeMetadata).

class_likes: HashMap<StringIdentifier, ClassLikeMetadata>

Map from class-like FQCN (StringIdentifier) to its detailed metadata (ClassLikeMetadata).

function_likes: HashMap<(StringIdentifier, StringIdentifier), FunctionLikeMetadata>

Map from a function/method identifier tuple (scope_id, function_id) to its metadata (FunctionLikeMetadata). scope_id is the FQCN for methods or often StringIdentifier::empty() for global functions.

symbols: Symbols

Stores the kind (Class, Interface, etc.) for every known symbol FQCN.

constants: HashMap<StringIdentifier, ConstantMetadata>

Map from global constant FQN (StringIdentifier) to its metadata (ConstantMetadata).

all_class_like_descendants: HashMap<StringIdentifier, HashSet<StringIdentifier>>

Map from class/interface FQCN to the set of all its descendants (recursive).

direct_classlike_descendants: HashMap<StringIdentifier, HashSet<StringIdentifier>>

Map from class/interface FQCN to the set of its direct descendants (children).

safe_symbols: HashSet<StringIdentifier>

Set of symbols (FQCNs) considered “safe”.

safe_symbol_members: HashSet<(StringIdentifier, StringIdentifier)>

Set of specific members (SymbolFQCN, MemberName) considered “safe” or trusted.

Implementations

impl CodebaseMetadata

pub fn new() -> Self

Creates a new, empty CodebaseMetadata with default values.

pub fn is_inheritable(&self, fq_class_name: &StringIdentifier) -> bool

Checks if a class-like structure can be part of an intersection. Generally, only final classes cannot be intersected further down the hierarchy.

pub fn class_or_trait_can_use_trait( &self, child_class: &StringIdentifier, parent_trait: &StringIdentifier, ) -> bool

pub fn get_classconst_literal_value( &self, fq_class_name: &StringIdentifier, const_name: &StringIdentifier, ) -> Option<&TAtomic>

Retrieves the literal value (as a TAtomic) of a class constant, if it was inferred. Returns None if the class/constant doesn’t exist or the value type wasn’t inferred.

pub fn property_exists( &self, classlike_name: &StringIdentifier, property_name: &StringIdentifier, ) -> bool

Checks if a property with the given name exists (is declared or inherited) within the class-like structure. Relies on ClassLikeMetadata::has_appearing_property.

pub fn method_exists( &self, classlike_name: &StringIdentifier, method_name: &StringIdentifier, ) -> bool

Checks if a method with the given name exists within the class-like structure. Relies on ClassLikeMetadata::has_method.

pub fn appearing_method_exists( &self, classlike_name: &StringIdentifier, method_name: &StringIdentifier, ) -> bool

Checks if a method with the given name exists (is declared or inherited) within the class-like structure. Relies on ClassLikeMetadata::has_appearing_method.

pub fn declaring_method_exists( &self, classlike_name: &StringIdentifier, method_name: &StringIdentifier, ) -> bool

Checks specifically if a method is declared directly within the given class-like (not just inherited).

pub fn get_declaring_class_for_property( &self, fq_class_name: &StringIdentifier, property_name: &StringIdentifier, ) -> Option<&StringIdentifier>

Finds the FQCN of the class/trait where a property was originally declared for a given class context. Returns None if the property doesn’t appear in the class hierarchy.

pub fn get_property_metadata( &self, fq_class_name: &StringIdentifier, property_name: &StringIdentifier, ) -> Option<&PropertyMetadata>

Retrieves the full metadata for a property as it appears in the context of a specific class. This might be the metadata from the declaring class. Returns None if the class or property doesn’t exist in this context.

pub fn get_property_type( &self, fq_class_name: &StringIdentifier, property_name: &StringIdentifier, ) -> Option<&TUnion>

Retrieves the type union for a property within the context of a specific class. It finds the declaring class of the property and returns its type signature. Returns None if the property or its type cannot be found.

pub fn get_appearing_method_id( &self, method_id: &MethodIdentifier, ) -> MethodIdentifier

Resolves a MethodIdentifier to the identifier of the method as it appears in the given class context. This could be the declaring class or an ancestor if inherited.

pub fn get_function_like( &self, identifier: &FunctionLikeIdentifier, interner: &ThreadedInterner, ) -> Option<&FunctionLikeMetadata>

Retrieves the metadata for a specific function-like construct using its identifier.

pub fn extend(&mut self, other: CodebaseMetadata)

Merges information from another CodebaseMetadata into this one. Collections are extended. For HashMaps, entries in other may overwrite existing ones.

pub fn take_issues(&mut self, user_defined: bool) -> IssueCollection

Trait Implementations

impl Clone for CodebaseMetadata

fn clone(&self) -> CodebaseMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodebaseMetadata

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

Formats the value using the given formatter.

impl Default for CodebaseMetadata

Provides a default, empty CodebaseMetadata.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodebaseMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CodebaseMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CodebaseMetadata

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 CodebaseMetadata