---
name: rust
description: This skill should be used every time you work on Rust projects or Rust code changes in this repository.
compatibility: opencode
title: rust
canonical_url: https://skilld.dev/gh/alpha-innovation-labs/opennexus-rs/rust
last_updated: 2026-10-06T18:42:02.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install alpha-innovation-labs/opennexus-rs/rust`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/rust`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/alpha-innovation-labs/opennexus-rs/rust) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/rust`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/rust --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/rust --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Rust Project Structure Rules

This file defines the preferred Rust project organization for this repo.

## Core Principles

1. Organize by domain and feature, not by type.
2. Keep orchestration glue in `app/`.
3. Split always-on logic into `core/` and optional capabilities into `features/`.
4. Each subdomain under `core/` and each feature under `features/` must be its own folder with clear boundaries.
5. Only add feature files that the feature actually needs (`state.rs`, `render.rs`, `ui.rs`, `helpers.rs`).
6. Avoid type-based folders like `constructors/`, `methods/`, `traits/`, or `enums/`.

## Top-Level Layout (Typical)

```
src/
├── lib.rs
├── main.rs
├── app/                 # orchestration, wiring, lifecycle
├── core/                # always-on domain + engine
├── features/            # optional capabilities
├── adapters/            # external boundaries (db, http, fs, cli)
├── services/            # infra helpers (watchers, git, timers)
├── config/              # config structs + loaders
└── utils/               # tiny pure helpers only
```

## Top-Level Layout (TUI)

```
src/
├── main.rs
├── app/                 # orchestration, event loop, wiring
├── widgets/             # widget modules (primary organization)
├── screens/             # view composition
├── adapters/            # external boundaries (fs, git, clipboard)
├── services/            # infra helpers (file watching, timers)
├── config/              # config structs + loaders
└── utils/               # tiny pure helpers only
```

## Folder Semantics

- `app/`: glue layer. Composition, wiring, lifecycle, and startup/teardown.
  - Web: `router.rs`, `lifecycle.rs`
  - TUI: `event_loop.rs`, `layout_wiring.rs`
- `core/`: required engine logic that defines the domain (non-TUI).
  - Web: `core/model/`, `core/engine/`
- `features/`: optional or additive capabilities (non-TUI). Each feature is a folder.
  - Web: `features/auth/`, `features/settings/`
  - TUI: `features/toc/`, `features/scrollbar`
- `widgets/`: primary TUI organization unit. Each widget is a bounded folder.
  - TUI: `widgets/markdown_widget/`, `widgets/command_palette/`
- `screens/`: TUI view composition and layout wiring.
  - TUI: `screens/dashboard.rs`, `screens/settings.rs`
- `adapters/`: outbound/inbound boundaries to external systems (storage is a kind of adapter).
  - Web: `adapters/http.rs`, `adapters/storage.rs`
  - TUI: `adapters/fs.rs`, `adapters/git.rs`
- `services/`: internal infrastructure helpers (file watching, git status, timers).
  - Web: `services/timer.rs`, `services/clock.rs`
  - TUI: `services/file_watcher.rs`, `services/git_status.rs`
- `config/`: config structs + loaders.
  - Web: `config/app_config.rs`
  - TUI: `config/tui_config.rs`
- `utils/`: tiny pure helpers only. No IO, no shared state.
  - Web: `utils/format.rs`
  - TUI: `utils/geometry.rs`

## Core Structure (Subdomain Boundaries)

Each core subdomain is its own folder. Keep code flat inside unless it grows.

```
src/core/
├── mod.rs
├── model/
├── engine/
├── parser/
├── render/
├── source/
├── events/
└── types/
```

## Feature Structure (Feature Boundaries)

Each feature is a folder. Add `state.rs`, `render.rs`, `ui.rs`, or `helpers.rs` only when the feature needs them.

```
src/features/
├── mod.rs
├── toc/
│   ├── mod.rs
│   ├── state.rs
│   ├── render.rs
│   └── helpers.rs
├── selection/
│   ├── mod.rs
│   ├── state.rs
│   └── helpers.rs
└── theme/
    ├── mod.rs
    ├── palette.rs
    ├── style.rs
    └── load.rs
```

## File Naming

1. Use snake_case filenames.
2. Filename matches the primary type or concern.
3. One logical concern per file.

## Example Structures

### Example: CLI App

```
src/
├── main.rs
├── app/
│   ├── mod.rs
│   ├── bootstrap.rs
│   └── wiring.rs
├── core/
│   ├── mod.rs
│   ├── model/
│   ├── parser/
│   └── engine/
├── features/
│   ├── mod.rs
│   ├── search/
│   │   ├── mod.rs
│   │   └── state.rs
│   └── export/
│       ├── mod.rs
│       └── helpers.rs
├── adapters/
│   ├── mod.rs
│   ├── cli.rs
│   └── fs.rs
├── services/
│   ├── mod.rs
│   └── file_watcher.rs
└── config/
    ├── mod.rs
    └── settings.rs
```

### Example: Web App (Dioxus)

```
src/
├── main.rs
├── app/
│   ├── mod.rs
│   ├── router.rs
│   └── wiring.rs
├── core/
│   ├── mod.rs
│   ├── model/
│   ├── engine/
│   └── events/
├── features/
│   ├── mod.rs
│   ├── auth/
│   │   ├── mod.rs
│   │   ├── state.rs
│   │   └── ui.rs
│   ├── dashboard/
│   │   ├── mod.rs
│   │   └── ui.rs
│   └── settings/
│       ├── mod.rs
│       └── ui.rs
├── adapters/
│   ├── mod.rs
│   └── http.rs
└── services/
    ├── mod.rs
    └── storage.rs
```

### Example: TUI App (ratatui)

```
src/
├── main.rs
├── app/
│   ├── mod.rs
│   ├── lifecycle.rs
│   └── wiring.rs
├── screens/
│   ├── mod.rs
│   ├── dashboard.rs
│   └── settings.rs
├── widgets/
│   ├── mod.rs
│   ├── markdown_widget/
│   │   ├── mod.rs
│   │   ├── widget/
│   │   ├── state/
│   │   ├── foundation/
│   │   └── extensions/
│   └── command_palette/
│       ├── mod.rs
│       ├── state.rs
│       └── render.rs
├── adapters/
│   ├── mod.rs
│   └── fs.rs
└── services/
    ├── mod.rs
    └── file_watcher.rs
```
