API Reference Jido.VFS v#1.0.0

Jido.VFS is a filesystem abstraction for Elixir providing a unified interface over many storage backends. It allows you to swap out filesystems on the fly without needing to rewrite your application code. Eliminate vendor lock-in, reduce technical debt, and improve testability.

Behaviour for how Jido.VFS adapters work.

Jido.VFS adapter using ETS (Erlang Term Storage) for in-memory storage.

Runtime configuration for the ETS adapter.

Collectable stream used to append chunks into the ETS adapter.

Versioning wrapper for ETS adapter.

Jido.VFS adapter for Git repositories with versioning support.

Runtime configuration for the Git adapter.

A GitHub virtual filesystem adapter for Jido.VFS.

Jido.VFS Adapter using an Agent for in memory storage.

Enumerable and collectable stream for chunked in-memory file access.

Runtime configuration for the in-memory adapter.

Versioning wrapper for InMemory adapter.

Jido.VFS adapter for the local filesystem.

Jido.VFS adapter for Amazon S3 compatible storage.

Runtime configuration for the S3 adapter.

Collectable stream for multipart uploads into S3-compatible storage.

Jido.VFS adapter for Fly.io Sprites.

Helpers for executing and validating shell commands against a Sprite client.

Runtime configuration for the Sprite adapter.

Versioning wrapper for Sprite adapter.

Collectable stream used to buffer writes before sending them to a Sprite.

Behaviour for versioning operations in Jido.VFS adapters.

OTP application entry point for Jido.VFS support processes.

Error handling module for Jido.VFS filesystem operations.

Absolute path not allowed error

Adapter-specific operation errors

Generic adapter error

Directory not empty error

Directory not found error

File not found error

Access denied or permission errors

Invalid operation or argument errors

Invalid path error

Path is not a directory error

File or resource not found errors

Path traversal attempt error

Permission denied error

Unknown or unexpected errors

Fallback unknown error

Unsupported operation error

Behaviour and delegation helpers for a Jido.VFS filesystem module.

Elixir registry to register adapter instances on for adapters, which need processes.

Utilities for validating and normalizing relative filesystem paths.

Represents a revision/commit in Jido.VFS.

Metadata for a directory entry returned by adapter listing and stat operations.

Metadata for a file entry returned by adapter listing and stat operations.

Helpers for working with portable and adapter-specific visibility values.

Jido.VFS.Visibility.UnixVisibilityConverter supporting Jido.VFS.Visibility.portable().

Visibility converter behaviour for unix based systems.

Install and configure Jido VFS for use in an application.

Shared documentation strings for the mix jido_vfs.install task.