Skip to main content

FileConfig

Struct FileConfig 

Source
pub struct FileConfig {
    pub project_type: Option<String>,
    pub dir: Option<PathBuf>,
    pub filtering: FileFilterConfig,
    pub scanning: FileScanConfig,
    pub execution: FileExecutionConfig,
}
Expand description

Top-level configuration file structure.

All fields are Option<T> so we can detect which values are present in the config file and apply layered configuration (CLI > config file > defaults).

Fields§

§project_type: Option<String>

Default project type filter (e.g., "rust", "node", "all")

§dir: Option<PathBuf>

Default directory to scan

§filtering: FileFilterConfig

Filtering options

§scanning: FileScanConfig

Scanning options

§execution: FileExecutionConfig

Execution options

Implementations§

Source§

impl FileConfig

Source

pub fn config_path() -> Option<PathBuf>

Returns the path where the configuration file is expected.

The configuration file is located at <config_dir>/clean-dev-dirs/config.toml, where <config_dir> is the platform-specific configuration directory (e.g., ~/.config on Linux/macOS, %APPDATA% on Windows).

§Returns

Some(PathBuf) with the config file path, or None if the config directory cannot be determined.

Source

pub fn load() -> Result<Self>

Load configuration from the default config file location.

If the config file doesn’t exist, returns a default (empty) configuration. If the file exists but is malformed, returns an error.

§Errors

Returns an error if:

  • The config file exists but cannot be read
  • The config file exists but contains invalid TOML or unexpected fields

Trait Implementations§

Source§

impl Debug for FileConfig

Source§

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

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

impl Default for FileConfig

Source§

fn default() -> FileConfig

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

impl<'de> Deserialize<'de> for FileConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,