fsmount

README

Simple FUSE bindings for Go fs.FS

This library is just a wrapper to easily mount fs.FS as a filesystem.

Dependencies:

• Windows: Dokan + dkango
• Linux: fuse + go-fuse
• MacOS: macFUSE + go-fuse

Usage

Setup FUSE

Windows:

winget install dokan-dev.Dokany

Linux(Ubuntu)

apt install fuse

examples/simple/simple.go

package main

import (
	"os"
	"github.com/binzume/fsmount"
)

func main() {
	mount, _ := fsmount.MountFS("X:", os.DirFS("."), nil)
	defer mount.Close()

	// Block forever
	select {}
}

How to create a writable FS?

See examples/writable/writable.go

go run ./examples/writable testdir R:

type WritableFS interface {
	fs.FS
	OpenWriter(name string, flag int) (io.WriteCloser, error)
	Truncate(name string, size int64) error
}

Other interfaces such as RemoveFS, MkdirFS, RenameFS... are also available.

License

MIT

Documentation

Index

• type MkdirFS
• type MountHandle
  • func MountFS(mountPoint string, fsys fs.FS, opt *MountOptions) (MountHandle, error)
• type MountOptions
• type OpenDirFS
• type OpenWriterFS
• type RemoveFS
• type RenameFS
• type TruncateFS

Types

type MkdirFS

type MkdirFS interface {
	fs.FS
	Mkdir(name string, mode fs.FileMode) error
}

type MountHandle

type MountHandle interface {
	io.Closer
}

func MountFS

func MountFS(mountPoint string, fsys fs.FS, opt *MountOptions) (MountHandle, error)

type MountOptions

type MountOptions struct {
	ReadOnly   bool // Windows only: Even if the file system supports writing file, treat as read-only.
	Debug      bool // Print debug logs.
	FuseOption interface{}
}

type OpenDirFS

type OpenDirFS interface {
	fs.FS
	OpenDir(name string) (fs.ReadDirFile, error)
}

type OpenWriterFS

type OpenWriterFS interface {
	fs.FS
	OpenWriter(name string, flag int) (io.WriteCloser, error)
}

type RemoveFS

type RemoveFS interface {
	fs.FS
	Remove(name string) error
}

type RenameFS

type RenameFS interface {
	fs.FS
	Rename(name string, newName string) error
}

type TruncateFS

type TruncateFS interface {
	fs.FS
	Truncate(name string, size int64) error
}