# alvinphilips/rats architecture

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

- Interactive diagram: https://gitdiagram.com/alvinphilips/rats
- Repository: https://github.com/alvinphilips/rats

## Overview

##### Project Type and Purpose
- This is a Rust library crate (“rats”) that implements a simple ASCII-text triangle rasterizer.

- Library Crate (src/)
- Geometry Module
– vertex.rs: Vertex struct + ContainsPoint trait
– line.rs: Line struct implements ContainsPoint
– triangle.rs: Triangle struct implements ContainsPoint
- Renderer Module
- Prelude Module
– prelude.rs: Re-exports frequently used types and traits for consumers
- lib.rs: Crate root, ties submodules together, exposes public API
- Example Binaries (examples/)
- input_file/*: binary that reads a “.trianglelist” file (serialize.rs), constructs triangles, invokes rendering
- External Dependencies
- Rust toolchain / Cargo

##### Relationships & Data Flows
- Renderer stores drawn pixels in an internal buffer → render() method serializes buffer to ASCII → prints to stdout
- input_file example adds a Serialization component (reading text → Triangle list) before driving Renderer

##### Key Architectural Patterns
- Modular crate with clear separation:
- Rendering logic (buffer management, ASCII output)
- Public API façade (Prelude)
- Zero-dependency design for maximum readability and portability
- Example binaries as clients demonstrating extensibility

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Library Crate
    subgraph "rats Library"
        Lib["lib.rs"]:::lib
        subgraph "Geometry Module"
            Vertex["Vertex"]:::geometry
            Line["Line"]:::geometry
            Triangle["Triangle"]:::geometry
            Bounds["Bounds"]:::geometry
            ContainsPoint["ContainsPoint trait"]:::geometry
            GetBounds["GetBounds trait"]:::geometry
        end
        Renderer["Renderer"]:::renderer
        Prelude["Prelude"]:::prelude
    end

    %% Example Applications
    subgraph "Example Applications"
        Demo["demo"]:::example
        TriangleApp["triangle"]:::example
        SquareApp["square"]:::example
        subgraph "input_file"
            InputFile["main.rs"]:::example
            Serialization["serialize.rs"]:::example
            SampleData[".trianglelist"]:::example
        end
    end

    %% External
    Cargo["Cargo / Rust toolchain"]:::external
    Stdout["stdout"]:::external

    %% Relationships
    Demo -->|"uses API"| Prelude
    TriangleApp -->|"uses API"| Prelude
    SquareApp -->|"uses API"| Prelude
    InputFile -->|"parses file"| Serialization
    Serialization -->|"constructs shapes via API"| Prelude
    Prelude -->|"re-exports API"| Lib
    Lib -->|"calls render() draw_*()"| Renderer
    Lib -->|"defines shapes"| Vertex
    Lib -->|"defines shapes"| Line
    Lib -->|"defines shapes"| Triangle
    Lib -->|"defines shapes"| Bounds
    Line -->|"implements"| ContainsPoint
    Triangle -->|"implements"| ContainsPoint
    Bounds -->|"implements"| GetBounds
    Triangle -->|"uses"| Vertex
    Line -->|"uses"| Vertex
    Renderer -->|"contains_point() / get_bounds()"| ContainsPoint
    Renderer -->|"contains_point() / get_bounds()"| GetBounds
    Renderer -->|"render()"| Stdout
    Cargo -.->|builds| Lib

    %% Click Events
    click Lib "https://github.com/alvinphilips/rats/blob/main/src/lib.rs"
    click Vertex "https://github.com/alvinphilips/rats/blob/main/src/vertex.rs"
    click Line "https://github.com/alvinphilips/rats/blob/main/src/line.rs"
    click Triangle "https://github.com/alvinphilips/rats/blob/main/src/triangle.rs"
    click Bounds "https://github.com/alvinphilips/rats/blob/main/src/bounds.rs"
    click ContainsPoint "https://github.com/alvinphilips/rats/blob/main/src/vertex.rs"
    click GetBounds "https://github.com/alvinphilips/rats/blob/main/src/bounds.rs"
    click Renderer "https://github.com/alvinphilips/rats/blob/main/src/renderer.rs"
    click Prelude "https://github.com/alvinphilips/rats/blob/main/src/prelude.rs"
    click Demo "https://github.com/alvinphilips/rats/blob/main/examples/demo.rs"
    click TriangleApp "https://github.com/alvinphilips/rats/blob/main/examples/triangle.rs"
    click SquareApp "https://github.com/alvinphilips/rats/blob/main/examples/square.rs"
    click InputFile "https://github.com/alvinphilips/rats/blob/main/examples/input_file/main.rs"
    click Serialization "https://github.com/alvinphilips/rats/blob/main/examples/input_file/serialize.rs"
    click SampleData "https://github.com/alvinphilips/rats/blob/main/examples/input_file/square.trianglelist"
    click Cargo "https://github.com/alvinphilips/rats/blob/main/Cargo.toml"

    %% Styles
    classDef geometry fill:#D0E8F2,stroke:#2C7BB6
    classDef renderer fill:#DFF2D8,stroke:#3A8E41
    classDef example fill:#F8D7DA,stroke:#C82333
    classDef prelude fill:#FFF3CD,stroke:#F0AD4E
    classDef lib fill:#E2E3E5,stroke:#6C757D
    classDef external fill:#F5F5F5,stroke:#AAAAAA,stroke-dasharray: 5 5
```
