async-fuse-rs is a async [Rust] library crate based on the rust-rs crate for easy implementation of [FUSE filesystems][libfuse] in userspace.
[Crate documentation][documentation]
A working FUSE filesystem consists of three parts:
- The kernel driver that registers as a filesystem and forwards operations into a communication channel to a userspace process that handles them.
- The userspace library (libfuse) that helps the userspace process to establish and run communication with the kernel driver.
- The userspace implementation that actually processes the filesystem operations.
The kernel driver is provided by the FUSE project, the userspace implementation needs to be provided by the developer. fuse-rs provides a replacement for the libfuse userspace library between these two. This way, a developer can fully take advantage of the Rust type interface and runtime features when building a FUSE filesystem in Rust.
Except for a single setup (mount) function call and a final teardown (unmount) function call to libfuse, everything runs in Rust.
FUSE must be installed to build or run programs that use fuse-rs (i.e. kernel driver and libraries. Some platforms may also require userland utils like fusermount). A default installation of FUSE is usually sufficient.
To build fuse-rs or any program that depends on it, pkg-config needs to be installed as well.
[FUSE for Linux][libfuse] is available in most Linux distributions and usually called fuse. To install on a Debian based system:
sudo apt-get install fuseInstall on CentOS:
sudo yum install fuseTo build, FUSE libraries and headers are required. The package is usually called libfuse-dev or fuse-devel. Also pkg-config is required for locating libraries and headers.
sudo apt-get install libfuse-dev pkg-configsudo yum install fuse-devel pkgconfigInstaller packages can be downloaded from the [FUSE for macOS homepage][FUSE for macOS].
To install using [Homebrew]:
brew cask install osxfuseTo install pkg-config (required for building only):
brew install pkg-configInstall packages fusefs-libs and pkgconf.
pkg install fusefs-libs pkgconfPut this in your Cargo.toml:
[dependencies]
async-fuse = { git = "https://github.com/jmpq/async-fuse-rs" }To create a new filesystem, implement the trait fuse::Filesystem. See the documentation for details or the examples directory for some basic examples.