Skip to main content

Project

Struct Project 

Source
pub struct Project {
    pub project_types: Vec<ProjectType>,
    pub path: PathBuf,
}
Expand description

A discovered project: a directory on disk plus the set of project types detected within it.

Obtain one via scan, or construct it directly. The struct is otherwise inert — call clean to delete the project’s artifact directories.

Fields§

§project_types: Vec<ProjectType>

Every project type detected in path (at least one). Ordered by ProjectType declaration order, de-duplicated.

§path: PathBuf

The project’s root directory.

Implementations§

Source§

impl Project

Source

pub fn artifact_dirs(&self) -> Vec<&'static str>

The de-duplicated union of artifact directories across all detected project types in this directory (e.g. a Cargo+Node project yields both target and node_modules).

Source

pub fn name(&self) -> Cow<'_, str>

The project’s path as a lossy UTF-8 string (for display).

Source

pub fn size(&self, options: &ScanOptions) -> u64

Total size in bytes of this project’s artifact directories — the amount clean would reclaim.

Source

pub fn last_modified(&self, options: &ScanOptions) -> Result<SystemTime, Error>

The most recent modification time across all entries in the project tree.

Source

pub fn size_dirs(&self, options: &ScanOptions) -> ProjectSize

Per-top-level-entry disk usage for the project: total artifact bytes, total non-artifact bytes, and a list of (name, size, is_artifact).

Source

pub fn type_name(&self) -> String

Human-readable project-type label(s), joined by " / " — e.g. "Cargo" or "Cargo / Node".

Source

pub fn clean(&self) -> Result<(), Box<dyn Error>>

Deletes the project’s artifact directories and their contents.

Every artifact directory is attempted even if an earlier one fails; the first error (if any) is returned so callers — e.g. a TUI — can surface it. Returns Ok(()) when all present artifact directories were removed.

Trait Implementations§

Source§

impl Clone for Project

Source§

fn clone(&self) -> Project

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Project

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.