Documentation / overview

The boundary is the product.

mount-rs gives Rust and Node applications a filesystem-shaped contract while keeping persistence, chunking, and mounting as explicit choices.

Practical reading order

Start with the direct contract, then look at composition. The API guide describes what exists in this repository today; acceptance requirements describe what is not yet a blanket guarantee.

Three layers, one observable contract

Core

FsDriver / FileHandle

Paths, handles, stats, directory operations, and explicit sync behavior.

Storage

MetadataStore + BlockStore

Namespace publication and immutable bytes are independent contracts.

Edge

Transports and bindings

FUSE, NFS, 9P, WebDAV, S3, auto-mount, CLI, and napi-rs are integration surfaces.

What the docs do—and do not—promise

The project is prerelease. Examples point to real exported types and repository paths, but a working example is not proof that every backend, platform, journal mode, or failure scenario has passed the full acceptance suite. The overall project is in progress and is not release-ready.

01 / Rust

Core and split-store APIs

Loopback access, handles, fixed-size chunking, and provider composition.

02 / Node

napi-rs factories

The current createChunkedDriver shape and lifecycle expectations.

Read the source alongside this guide: architecture, porting evidence, requirements, and work tracker.