CodeIR

Struct CodeIR 

Source
pub struct CodeIR {
    pub file_path: PathBuf,
    pub module: Option<ModuleEntity>,
    pub functions: Vec<FunctionEntity>,
    pub classes: Vec<ClassEntity>,
    pub traits: Vec<TraitEntity>,
    pub calls: Vec<CallRelation>,
    pub imports: Vec<ImportRelation>,
    pub inheritance: Vec<InheritanceRelation>,
    pub implementations: Vec<ImplementationRelation>,
}
Expand description

Intermediate representation of extracted code

This is the bridge between language-specific AST and the CodeGraph database. Parsers extract entities and relationships into this IR, then the IR is inserted into the graph in a batch operation.

Fields§

§file_path: PathBuf

Source file path

§module: Option<ModuleEntity>

Module/file entity

§functions: Vec<FunctionEntity>

Extracted functions

§classes: Vec<ClassEntity>

Extracted classes

§traits: Vec<TraitEntity>

Extracted traits/interfaces

§calls: Vec<CallRelation>

Function call relationships

§imports: Vec<ImportRelation>

Import relationships

§inheritance: Vec<InheritanceRelation>

Inheritance relationships

§implementations: Vec<ImplementationRelation>

Implementation relationships

Implementations§

Source§

impl CodeIR

Source

pub fn new(file_path: PathBuf) -> Self

Create a new empty IR

Source

pub fn entity_count(&self) -> usize

Total number of entities

Source

pub fn relationship_count(&self) -> usize

Total number of relationships

Source

pub fn set_module(&mut self, module: ModuleEntity)

Add a module entity

Source

pub fn add_function(&mut self, func: FunctionEntity)

Add a function

Source

pub fn add_class(&mut self, class: ClassEntity)

Add a class

Source

pub fn add_trait(&mut self, trait_entity: TraitEntity)

Add a trait

Source

pub fn add_call(&mut self, call: CallRelation)

Add a call relationship

Source

pub fn add_import(&mut self, import: ImportRelation)

Add an import relationship

Source

pub fn add_inheritance(&mut self, inheritance: InheritanceRelation)

Add an inheritance relationship

Source

pub fn add_implementation(&mut self, implementation: ImplementationRelation)

Add an implementation relationship

Trait Implementations§

Source§

impl Clone for CodeIR

Source§

fn clone(&self) -> CodeIR

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CodeIR

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CodeIR

Source§

fn default() -> CodeIR

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for CodeIR

§

impl RefUnwindSafe for CodeIR

§

impl Send for CodeIR

§

impl Sync for CodeIR

§

impl Unpin for CodeIR

§

impl UnwindSafe for CodeIR

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.