Struct Config

pub struct Config {
    pub analyzer: AnalyzerSettings,
    pub rules: RulesConfig,
    pub reporter: ReporterConfig,
    pub renderer_analysis: RendererAnalysisConfig,
    /* private fields */
}

Export public API Configuration for the Orbit Analyzer

Fields

analyzer: AnalyzerSettings

Analyzer settings

rules: RulesConfig

Rules configuration

reporter: ReporterConfig

Reporter configuration

renderer_analysis: RendererAnalysisConfig

Renderer analysis settings

Implementations

impl Config

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, Box<dyn Error>>

Load configuration from a file

pub fn find_and_load() -> Result<Self, Box<dyn Error>>

Find and load configuration from the default location

pub fn is_rule_enabled(&self, rule_name: &str) -> bool

Check if a rule is enabled

pub fn get_rule_severity( &self, rule_name: &str, default_severity: Severity, ) -> Severity

Get the severity level for a rule

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.