# VFS v0.1.0 - Table of Contents

Protocol-based virtual filesystem for the Elixir AI tools stack — pluggable backends, state threading, lazy reads, and a tiny core surface.

## Pages

- [VFS](readme.md)
- [vfs — protocol-based virtual filesystem for the Elixir AI tools stack](spec.md)
- [Changelog](changelog.md)

## Modules

- Core
  - [VFS](VFS.md): Protocol-based virtual filesystem.
  - [VFS.Error](VFS.Error.md): Structured error returned by every fallible `VFS.Mountable` op.
  - [VFS.Mountable](VFS.Mountable.md): Pluggable virtual filesystem.
  - [VFS.Path](VFS.Path.md): Pure path utilities for `VFS`.
  - [VFS.Stat](VFS.Stat.md): Metadata for a path in a virtual filesystem.

- Backends & helpers
  - [VFS.Default](VFS.Default.md): Fallback implementations of `VFS.Mountable` ops, composed from the
required primitives. Used by `VFS.Skeleton` to fill in defaults for
backends that don't override.

  - [VFS.Memory](VFS.Memory.md): In-memory `VFS.Mountable` backend.
  - [VFS.Skeleton](VFS.Skeleton.md): Default implementations of the optional `VFS.Mountable` ops a backend
doesn't override.
  - [VFS.StreamOptions](VFS.StreamOptions.md): Helper module for backend authors implementing `stream_read/3`. Applies
the documented options (`:chunk_size`, `:byte_range`, `:line_range`) to
a binary content and returns a chunk Stream — or `{:error, :einval}`
for malformed options.