Struct InstantiatedConfig 

pub struct InstantiatedConfig {
    pub root_dirs: RootDirs,
    pub code_results_subdir_regex: Option<Regex>,
    pub lints: Vec<LintCheck>,
    pub root_files: Vec<PathBuf>,
    pub readme_names: Option<Vec<String>>,
    pub workflow_names: Option<Vec<String>>,
    pub ignored: Vec<PathBuf>,
}

The internal representation of all the important files, directories, and lints to check.

This data structure isn’t created directly from a configuration file. It is instead instantiated from the ConfigFile struct, using some intermediate logic that can fail along the way.

Fields

root_dirs: RootDirs

Expected top-level directories to organize the project folder.

code_results_subdir_regex: Option<Regex>

Regular expression for units of analysis within the code and their matching results.

The default value for this regular expression is CODE_RESULTS_SUBDIR_REGEX.

lints: Vec<LintCheck>

The explicit list of lint checks that should be performed. See LintCheck for the complete list.

root_files: Vec<PathBuf>

The explicit list of files that should be present at the root of the project directory.

readme_names: Option<Vec<String>>

The file name for the READMEs that should be present within each subdirectory in the code and data directories.

workflow_names: Option<Vec<String>>

The file name for the workflow file that should be present within each subdirectory in the code directory.

ignored: Vec<PathBuf>

The set of directories that are ignored during checks.

Implementations

impl InstantiatedConfig

pub fn execute_lints(self) -> Result<(), LintError>

The main method to run all the requested lints on the project directory.

pub(crate) fn check_root_dirs(&self) -> Result<(), LintError>

Check for the presence of each required root directory.

pub(crate) fn check_root_files(&self) -> Result<(), LintError>

Check for the presence of each required file in the project root.

pub(crate) fn check_code_subdir_workflows(&self) -> Result<(), LintError>

Check for the presence of workflow files within each code subdirectory.

pub(crate) fn check_code_subdir_readmes(&self) -> Result<(), LintError>

Check for the existence of at least one acceptable README file in the code directory.

pub(crate) fn check_data_subdir_readmes(&self) -> Result<(), LintError>

Check for the existence of at least one acceptable README file in the data directory.

pub(crate) fn check_code_results_subdir_regex(&self) -> Result<(), LintError>

Check that the subdirectories of the code and results follow the correct style.

pub(crate) fn check_code_results_subdir_pairing(&self) -> Result<(), LintError>

Check that every subdirectory within code has a corresponding subdirectory in results and vice versa.

Trait Implementations

impl Clone for InstantiatedConfig

fn clone(&self) -> InstantiatedConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstantiatedConfig

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

Formats the value using the given formatter.

impl Default for InstantiatedConfig

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<&ConfigFile> for InstantiatedConfig

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from(value: &ConfigFile) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Path> for InstantiatedConfig

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from(value: &Path) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&PathBuf> for InstantiatedConfig

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from(value: &PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ConfigFile> for InstantiatedConfig

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from(value: ConfigFile) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PathBuf> for InstantiatedConfig

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from(value: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.