# bootandy/dust architecture

> Architecture diagram of the GitHub repository bootandy/dust, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bootandy/dust
- Repository: https://github.com/bootandy/dust

## Overview

##### Main Components

a. Core Components:
- CLI Interface (src/cli.rs)
- Directory Walker (src/dir_walker.rs)
- System (src/display.rs, src/display_node.rs)
- Node Management (src/node.rs)
- Configuration Handler (src/config.rs)
- Filtering System (src/filter.rs, src/filter_type.rs)

b. Supporting Components:
- Platform-specific Operations (src/platform.rs)
- Progress Tracking (src/progress.rs)
- Utility Functions (src/utils.rs)

**┌─────────────────────────────────────────────┐**
- CLI Interface               │
- ┬─────────────┬──────────────┘

**┌───────────────▼─┐    ┌─────▼────────┐**
- Config Handler  │    │ Dir Walker   │
- ┬─┘    └──────┬───────┘

**┌───────────────▼─────────────▼───────┐**
- Node Management           │
- ┬───────────────────┬─┘

**┌───────────────▼─┐         ┌──────▼──────┐**
- Filtering System│         │Display System│
- ┘         └─────────────┘

##### Important Relationships

a. Data Flow:
- CLI Interface → Config Handler (configuration parsing)
- CLI Interface → Dir Walker (initiating directory scanning)
- Dir Walker → Node Management (creating directory tree)
- Node Management → Filtering System (applying filters)
- Node Management → Display System (rendering output)

b. Cross-cutting Concerns:
- Progress Tracking (affects multiple components)
- Platform-specific operations (used by multiple components)

##### Additional Elements

**Raw File System → Directory Tree → Filtered Tree → Formatted Output**

##### Implementation Details to Highlight

- Configuration file locations (~/.config/dust/config.toml, ~/.dust.toml)
- Support for different output formats (ASCII, JSON)
- Filter types (size-based, regex, file type)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Core Components
    CLI["CLI Interface"]:::io
    DW["Directory Walker"]:::core
    DS["Display System"]:::io
    NM["Node Management"]:::core
    CH["Config Handler"]:::support
    FS["Filtering System"]:::support
    PO["Platform Operations"]:::support
    PT["Progress Tracking"]:::support
    UT["Utility Functions"]:::support
    ME["Main Entry"]:::core

    %% Relationships
    ME --> CLI
    CLI --> CH
    CLI --> DW
    DW --> NM
    NM --> FS
    NM --> DS
    
    %% Cross-cutting concerns
    PO -.-> DW
    PO -.-> NM
    PT -.-> DW
    PT -.-> NM
    UT -.-> CLI
    UT -.-> NM
    UT -.-> DS

    %% Data Pipeline
    subgraph Pipeline
        FS1["Raw File System"] --> DT["Directory Tree"]
        DT --> FT["Filtered Tree"]
        FT --> FO["Formatted Output"]
    end

    %% External Systems
    subgraph External
        FileSystem[("File System")]
        Terminal[("Terminal")]
        ConfigFiles[("Config Files")]
    end

    DW --> FileSystem
    DS --> Terminal
    CH --> ConfigFiles

    %% Click Events
    click CLI "https://github.com/bootandy/dust/blob/master/src/cli.rs"
    click DW "https://github.com/bootandy/dust/blob/master/src/dir_walker.rs"
    click DS "https://github.com/bootandy/dust/blob/master/src/display.rs"
    click NM "https://github.com/bootandy/dust/blob/master/src/node.rs"
    click CH "https://github.com/bootandy/dust/blob/master/src/config.rs"
    click FS "https://github.com/bootandy/dust/blob/master/src/filter.rs"
    click PO "https://github.com/bootandy/dust/blob/master/src/platform.rs"
    click PT "https://github.com/bootandy/dust/blob/master/src/progress.rs"
    click UT "https://github.com/bootandy/dust/blob/master/src/utils.rs"
    click ME "https://github.com/bootandy/dust/blob/master/src/main.rs"

    %% Styles
    classDef core fill:#2374ab,stroke:#2374ab,color:white
    classDef io fill:#57a773,stroke:#57a773,color:white
    classDef support fill:#ff8c42,stroke:#ff8c42,color:white
    classDef external fill:#gray,stroke:#gray,color:white

    %% Legend
    subgraph Legend
        C1["Core Processing"]:::core
        I1["Input/Output"]:::io
        S1["Support Systems"]:::support
        E1["External Systems"]:::external
    end
```
