Struct Analysis

Source
pub struct Analysis<T>
where T: LanguageType,
{ pub file_types: &'static [&'static str], pub project_files: RefCell<Vec<ProjectFile<T>>>, }

Fields§

§file_types: &'static [&'static str]§project_files: RefCell<Vec<ProjectFile<T>>>

Implementations§

Source§

impl<T> Analysis<T>
where T: LanguageType,

Source

pub fn new() -> Self

Creates a new Analysis instance.

§Example
use thinlinelib::analysis::Analysis;
use thinlinelib::language_type::{C, LanguageType};

let analysis: Analysis<C> = Analysis::new();

assert_eq!(analysis.file_types, C::file_types());
assert_eq!(analysis.project_files().len(), 0);
Source

pub fn project_files(&self) -> Ref<'_, Vec<ProjectFile<T>>>

Returns a reference to the collected project files for analysis.

Source

pub fn project_files_mut(&self) -> RefMut<'_, Vec<ProjectFile<T>>>

Returns a mutable reference to the collected project files for analysis.

§Example
use thinlinelib::analysis::{Analysis, ProjectFile};
use thinlinelib::language_type::C;

let analysis: Analysis<C> = Analysis::new();
let mut project_files = analysis.project_files_mut();
assert_eq!(project_files.len(), 0);

project_files.push(ProjectFile::new("test/anotherFile"));
assert_eq!(project_files.len(), 1);
Source

pub fn collect_sources( &self, project_dir: &PathBuf, search_dirs: &[String], ) -> Fallible<()>

Collects all the sources within the given project dir.

Source

pub fn extract_entities(&self) -> Fallible<()>

Extracts function signatures and comments of thinlines parsed files.

Trait Implementations§

Source§

impl<T> Debug for Analysis<T>
where T: LanguageType + Debug,

Source§

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

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

impl<T> Default for Analysis<T>
where T: LanguageType + Default,

Source§

fn default() -> Analysis<T>

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

Auto Trait Implementations§

§

impl<T> !Freeze for Analysis<T>

§

impl<T> !RefUnwindSafe for Analysis<T>

§

impl<T> Send for Analysis<T>
where T: Send,

§

impl<T> !Sync for Analysis<T>

§

impl<T> Unpin for Analysis<T>
where T: Unpin,

§

impl<T> UnwindSafe for Analysis<T>
where T: UnwindSafe,

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> 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, 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.