Struct cargo_scout_lib::config::rust::CargoConfig

pub struct CargoConfig { /* fields omitted */ }

This struct represents a Cargo project configuration.

Methods

impl CargoConfig

pub fn from_manifest_path(p: impl AsRef<Path>) -> Result<Self, Error>

This function will instantiate a Config from a Cargo.toml path.

If in a workspace, get_members will return the members of the [[workspace]] members section in Cargo.toml.

Else, it will return vec![".".to_string()]

cargo-scout-lib example

let config = CargoConfig::from_manifest_path("Cargo.toml")?;
// There is only one directory to lint, which is the current one.
assert_eq!(vec!["."], config.members());

cargo-scout workspace example

let config = CargoConfig::from_manifest_path("../Cargo.toml")?;
// We will lint `./cargo-scout` and `./cargo-scout-lib`.
assert_eq!(vec!["cargo-scout".to_string(), "cargo-scout-lib".to_string()], config.members());

Trait Implementations

impl Config for CargoConfig

#[must_use] fn members(&self) -> Vec<String>

This function should return a list of relative paths a linter will iterate on.