SmellDetector

Struct SmellDetector 

Source
pub struct SmellDetector { /* private fields */ }
Expand description

Main smell detector that runs all enabled detectors.

Implementations§

Source§

impl SmellDetector

Source

pub fn new() -> Self

Create a new smell detector with default configuration.

Source

pub fn with_config(config: SmellConfig) -> Self

Create a new smell detector with the given configuration.

Source

pub fn from_config_file(path: &Path) -> Result<Self>

Load configuration from a file.

Source

pub fn config(&self) -> &SmellConfig

Get the current configuration.

Source

pub fn min_severity(&self) -> Severity

Get minimum severity from config.

Source

pub fn analyze_file(&self, path: &Path) -> Result<Report>

Analyze a file (L5X or PLCopen) and return a report.

Source

pub fn analyze(&self, project: &LoadedProject) -> Result<Report>

Analyze a loaded project.

Source

pub fn analyze_controller(&self, controller: &Controller) -> Result<Report>

Analyze a parsed L5X controller.

Source

pub fn get_stats_file(&self, path: &Path) -> Result<ParseStats>

Get statistics for a file without running smell detection.

Source

pub fn get_stats(&self, project: &LoadedProject) -> Result<ParseStats>

Get statistics for a loaded project (L5X format).

Source

pub fn get_plcopen_stats(&self, project: &LoadedProject) -> Result<PlcopenStats>

Get PLCopen statistics for a loaded project.

Trait Implementations§

Source§

impl Default for SmellDetector

Source§

fn default() -> Self

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

Auto Trait Implementations§

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.