Struct Module 

pub struct Module {
    pub source: Source,
    pub names: ResolvedNames,
    pub parse_error: Option<ParseError>,
    pub reflection: Option<CodebaseReflection>,
    pub issues: IssueCollection,
}

Module represents a processed PHP source code module.

It encapsulates the original source, resolved names, any parsing errors, optional reflection data (if enabled), and a collection of semantic issues.

Fields

source: Source

names: ResolvedNames

parse_error: Option<ParseError>

reflection: Option<CodebaseReflection>

issues: IssueCollection

Implementations

impl Module

pub fn build( interner: &ThreadedInterner, version: PHPVersion, source: Source, options: ModuleBuildOptions, ) -> Self

Builds a Module from a given PHP source.

This convenience function parses the PHP source code to generate an abstract syntax tree (AST), resolves names, optionally performs reflection and/or semantic validation based on the provided build options, and collects any issues encountered during analysis.

Internally, it delegates to [build_with_ast] and discards the AST.

Arguments

• interner - A reference to a ThreadedInterner used for efficient string interning.
• version - The PHP version guiding the parsing and analysis.
• source - The PHP source code encapsulated in a Source struct.
• options - The build options controlling reflection and validation.

Returns

A new Module instance containing the resolved names, any parse errors, optional reflection data, and a collection of issues.

pub fn build_with_ast( interner: &ThreadedInterner, version: PHPVersion, source: Source, options: ModuleBuildOptions, ) -> (Self, Program)

Builds a Module from a given PHP source and returns the associated AST.

This function performs the complete module processing workflow:

• Parses the PHP source to generate an AST (Program).
• Resolves symbol names.
• Optionally performs reflection and/or semantic validation based on the provided build options.
• Collects any issues encountered during analysis.

Arguments

• interner - A reference to a ThreadedInterner for efficient string interning.
• version - The PHP version used to guide parsing and analysis.
• source - The PHP source code encapsulated in a Source struct.
• options - The build options that control reflection and validation.

Returns

A tuple containing:

• A Module instance with the processed data (names, reflection, issues, etc.).
• The Program representing the parsed abstract syntax tree (AST) of the source.

This is useful when the AST is required immediately before moving the module to another context (e.g., across threads) so that the cost of re-parsing can be avoided.

pub fn parse(&self, interner: &ThreadedInterner) -> Program

Parses the module’s source code to generate an abstract syntax tree (AST).

For performance reasons, the AST is not stored within the module. If an AST is needed later, this method re-parses the source code on demand.

Arguments

• interner - A reference to a ThreadedInterner used for efficient string handling during parsing.

Returns

A Program representing the abstract syntax tree (AST) of the module.

pub const fn category(&self) -> SourceCategory

Retrieves the category of the module’s source.

This method extracts the source category (e.g., user-defined, built-in, external) from the module’s source identifier.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Module

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Module

fn eq(&self, other: &Module) -> 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 Module

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Module

impl StructuralPartialEq for Module