---
name: egui-cow-document-model
description: >-
  Use this skill when exploring, understanding, designing, or modifying an immutable/copy-on-write (Arc) document model, sparse chunked/tiled storage, O(1) snapshot undo/redo history, or compile-time complete content-addressed file persistence in an engine-first Rust and egui application.
title: egui-cow-document-model
canonical_url: https://skilld.dev/gh/domesticmouse/skills/egui-cow-document-model
last_updated: 2026-10-28T00:30:50.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.
>
> Supporting files, fetch one when the Skill refers to it: [references/cow-tiles-and-history.md](https://skilld.dev/api/skills-raw/domesticmouse/skills/egui-cow-document-model/references/cow-tiles-and-history.md).
>
> If the user asked to install this Skill, run `npx skilld install domesticmouse/skills/egui-cow-document-model`. 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/egui-cow-document-model`, 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/domesticmouse/skills/egui-cow-document-model) 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/egui-cow-document-model`. 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/egui-cow-document-model --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/egui-cow-document-model --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.

# Copy-on-Write Document Model, Snapshot History & Persistence

This skill covers how application state is stored, mutated, undone, and persisted across `L0` (containers/chunks), `L1` (`doc`), `L2` (`ops`), and `L3` (`format`) so that an `egui` UI can render and mutate large documents with zero-copy undo/redo.

## Core Rules

1. **Pure Serializable Domain Model (`L1`):**
   - `Document` and its child entities in `crates/doc` are pure data structures (`Serialize`, `Deserialize`, `Clone`) with no UI or rendering dependencies.
2. **Sparse Copy-on-Write (`Arc`) Storage:**
   - Large buffers or collections are partitioned into fixed-size chunks/tiles stored in `BTreeMap<ChunkId, Arc<Chunk>>`.
   - Mutating a chunk uses `Arc::make_mut`, cloning only the touched chunk while sharing all untouched chunks across snapshots.
   - Allocating buffers from untrusted/external dimensions uses fallible reservation (`Vec::try_reserve_exact` $\to$ `AllocationError`) so huge/hostile inputs never abort the process.
3. **Whole-Document Snapshot History (`O(chunks)` pointer copy, zero data copy):**
   - Because heavy data payloads are `Arc`-shared, cloning a `Document` costs only pointer copies.
   - `History` (`crates/ops`) stores `VecDeque<HistoryState>` where each `HistoryState` holds `Arc<Document>` plus `SelectionTarget` (the active/selected entity IDs when the state was created).
   - Memory is bounded by `max_states` and `max_bytes` (counting unique `Arc<Chunk>` addresses via `Arc::as_ptr`).
4. **Compile-Time Complete Native Format:**
   - `crates/format` serializes `Document` into a bundle with `manifest.json` + content-addressed `blobs/<blake3>.zst`.
   - Struct conversions in `crates/format/src/convert.rs` deliberately destructure `doc` structs **without `..`** so adding a field to `doc` fails compilation until `format` (with `#[serde(default)]`) explicitly handles it.

---

## Workflow: Adding or Modifying Document State

1. **Add the field in `crates/doc`** with `Serialize, Deserialize` (and `#[serde(default)]` where needed).
2. **Update `crates/format/src/manifest.rs` and `convert.rs`** (which will fail to compile until you wire the new field) with `#[serde(default)]` so existing saved files continue to load.
3. **Mutate via `Session::edit` in `crates/engine`**, which automatically snapshots `before: Arc<Document>`, applies the mutation closure, computes `step_damage(&before, &after)`, records the undo state (or coalesces if the interactive `egui` `"coalesce"` key matches), and increments `DocState::revision` so the `egui` viewport knows to repaint.
4. See [cow-tiles-and-history.md](https://skilld.dev/api/skills-raw/domesticmouse/skills/egui-cow-document-model/references/cow-tiles-and-history.md) for concrete code patterns.

## Validation Steps

See [egui-testing-infrastructure](../egui-testing-infrastructure/SKILL.md) for property-based (`proptest!`) COW chunk testing, round-trip corpus oracles, and memory/RSS benchmarking:

```sh
cargo test -p <app>-doc -p <app>-ops -p <app>-format --lib --tests
cargo clippy -p <app>-doc -p <app>-ops -p <app>-format --all-targets -- -D warnings
```
