dkango

README

Dokan bindings for Go

This is a Go library to implement a user-mode file system on Windows using Dokan.

• Depends only on the Dokan library (No cgo)
• io/fs.FS interface support
• Implemented as a backend for https://github.com/binzume/fsmount (cross platform)

Usage

Install Dokan library

winget install dokan-dev.Dokany

API

The only recommended interface is dkango.MountFS(mountPoint, fsys, options). You can add your file system to Windows with a few lines of code.

dokan package provides the low-level API for Dokan, but it is not yet a stable interface. Small breaking changes will be made in the future without any notice.

examples/simple/simple.go

package main

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

func main() {
	mount, err := dkango.MountFS("X:", os.DirFS("."), nil)
	if err != nil {
		panic(err)
	}
	defer mount.Close()

	// Block forever
	select {}
}

How to create a writable FS?

See examples/writable/writable.go

go run ./examples/writable testdir R:

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

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

License

MIT

Documentation

Index

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

Constants

const (
	// Enable debug messages
	FlagDebug = dokan.DOKAN_OPTION_DEBUG
	// Output debug messages to stderr
	FlagStderr = dokan.DOKAN_OPTION_STDERR
	// Enable filename:streamname path
	FlagAltStream = dokan.DOKAN_OPTION_ALT_STREAM
	// Readonly FS even if fsys implements OpenWriterFS.
	FlagsWriteProtect = dokan.DOKAN_OPTION_WRITE_PROTECT
	// Network drive
	FlagNetwork = dokan.DOKAN_OPTION_NETWORK
	// Removable drive
	FlagRemovable = dokan.DOKAN_OPTION_REMOVABLE
)

Functions

func MountFS

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

MountFS mounts fsys on mountPoint.

mountPoint must be a valid unused drive letter or a directory on NTFS.

To provide random access, file opened by fsys should implement io.Seeker or ReaderAt and WriterAt. If only sequential access is provided, many applications will not work properly.

Types

type DiskSpace

type DiskSpace struct {
	FreeBytesAvailable     uint64
	TotalNumberOfBytes     uint64
	TotalNumberOfFreeBytes uint64
}

DiskSpace represents the amount of space that is available on a disk. https://docs.microsoft.com/ja-JP/windows/win32/api/fileapi/nf-fileapi-getdiskfreespaceexa

type MkdirFS

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

An interface to make new directories in the file system.

type MountOptions

type MountOptions struct {
	VolumeInfo    dokan.VolumeInformation
	DiskSpaceFunc func() DiskSpace // optional
	Flags         uint32
}

type OpenDirFS

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

An interface for preferentially opening ReadDirFile. If OpenDirFS is not implemented, try using fs.ReadDirFS, then Open file and try using fs.ReadDirFile.

type OpenWriterFS

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

An interface for opening files for writing.

type RemoveFS

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

An interface to remove file or directory from the file system.

type RenameFS

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

An interface to rename file or directory from the file system.

type TruncateFS

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

An interface to truncate file to specified size. If TruncateFS is not implemented, open file and try using file.Truncate(size).