Skip to main content

StoreInventory

Struct StoreInventory 

Source
pub struct StoreInventory {
    pub root: PathBuf,
    pub entries: BTreeMap<String, StoreEntry>,
}
Expand description

Walked store inventory — every entry under the source root, keyed by basename for O(1) lookup. Operators query by name pattern, by file-count, by size, etc.

Fields§

§root: PathBuf

Source root.

§entries: BTreeMap<String, StoreEntry>

Entries keyed by basename.

Implementations§

Source§

impl StoreInventory

Source

pub fn walk(profile: &StoreInventoryProfile) -> Result<Self, SpecError>

Walk the source root once, build a typed inventory per the supplied profile.

§Errors
  • inventory-bad-root if the source root doesn’t exist.
  • inventory-bad-pattern if the skip regex doesn’t compile.
  • inventory-io for filesystem failures.
Source

pub fn get(&self, name: &str) -> Option<&StoreEntry>

Lookup by basename.

Source

pub fn filter_by_name( &self, pattern: &str, ) -> Result<Vec<&StoreEntry>, SpecError>

Filter entries by name regex.

§Errors

Returns inventory-bad-pattern if the regex doesn’t compile.

Source

pub fn filter_by_size( &self, predicate: impl Fn(u64) -> bool, ) -> Vec<&StoreEntry>

Filter entries by file_count predicate.

Source

pub fn total_size(&self) -> u64

Total size summed across all entries.

Source

pub fn total_files(&self) -> usize

Total file count summed across all entries.

Trait Implementations§

Source§

impl Clone for StoreInventory

Source§

fn clone(&self) -> StoreInventory

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 StoreInventory

Source§

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

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

impl Default for StoreInventory

Source§

fn default() -> StoreInventory

Returns the “default value” for a type. 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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = 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.