fuse-bindings
Advanced tools
Fully maintained fuse bindings for Node that aims to cover the entire FUSE api
Fully maintained fuse bindings for Node that aims to cover the entire FUSE api
npm install fuse-bindings
Compared to fuse4js these bindings cover almost the entire FUSE api (except for locking) and doesn't do any buffer copys in read/write. It also supports unmount and mouting of multiple fuse drives.
You need to have FUSE installed (or Dokany on Windows)
sudo apt-get install libfuse-devbrew install pkg-configWindows down below...WARNING: Dokany is still not quite stable. It can cause BSODs. Be careful.
Using this on Windows is slightly more complicated. You need to install Dokany (for dokanfuse.lib, dokanctl.exe, driver and service) and clone its repo (for the headers).
Once the Dokany repo is cloned, you also need to set environment variable DOKAN_INSTALL_DIR to the path to DokenLibrary of your Dokany installaton, and DOKAN_FUSE_INCLUDE to the path to *dokany repo*\dokan_fuse\include.
Try creating an empty folder called mnt and run the below example
var fuse = require('fuse-bindings')
fuse.mount('./mnt', {
readdir: function (path, cb) {
console.log('readdir(%s)', path)
if (path === '/') return cb(0, ['test'])
cb(0)
},
getattr: function (path, cb) {
console.log('getattr(%s)', path)
if (path === '/') {
cb(0, {
mtime: new Date(),
atime: new Date(),
ctime: new Date(),
size: 100,
mode: 16877,
uid: process.getuid(),
gid: process.getgid()
})
return
}
if (path === '/test') {
cb(0, {
mtime: new Date(),
atime: new Date(),
ctime: new Date(),
size: 12,
mode: 33188,
uid: process.getuid(),
gid: process.getgid()
})
return
}
cb(fuse.ENOENT)
},
open: function (path, flags, cb) {
console.log('open(%s, %d)', path, flags)
cb(0, 42) // 42 is an fd
},
read: function (path, fd, buf, len, pos, cb) {
console.log('read(%s, %d, %d, %d)', path, fd, len, pos)
var str = 'hello world\n'.slice(pos)
if (!str) return cb(0)
buf.write(str)
return cb(str.length)
}
})
process.on('SIGINT', function () {
fuse.unmount('./mnt', function () {
process.exit()
})
})
fuse.mount(mnt, ops, [cb])Mount a new filesystem on mnt.
Pass the FUSE operations you want to support as the ops argument.
fuse.unmount(mnt, [cb])Unmount a filesystem
fuse.context()Returns the current fuse context (pid, uid, gid). Must be called inside a fuse callback.
ops.optionsSet mount options
ops.options = ['direct_io'] // set the direct_io option
ops.displayFolderSet to true to make OSX display a folder icon and the folder name as the mount point in finder
ops.forceSet to true to force mount the filesystem (will do an unmount first)
Most of the FUSE api is supported. In general the callback for each op should be called with cb(returnCode, [value]) where the return code is a number (0 for OK and < 0 for errors). See below for a list of POSIX error codes.
ops.init(cb)Called on filesystem init.
ops.access(path, mode, cb)Called before the filesystem accessed a file
ops.statfs(path, cb)Called when the filesystem is being stat'ed. Accepts a fs stat object after the return code in the callback.
ops.statfs = function (path, cb) {
cb(0, {
bsize: 1000000,
frsize: 1000000,
blocks: 1000000,
bfree: 1000000,
bavail: 1000000,
files: 1000000,
ffree: 1000000,
favail: 1000000,
fsid: 1000000,
flag: 1000000,
namemax: 1000000
})
}
ops.getattr(path, cb)Called when a path is being stat'ed. Accepts a stat object (similar to the one returned in fs.stat(path, cb)) after the return code in the callback.
ops.getattr = function (path, cb) {
cb(0, {
mtime: new Date(),
atime: new Date(),
ctime: new Date(),
size: 100,
mode: 16877,
uid: process.getuid(),
gid: process.getgid()
})
}
ops.fgetattr(path, fd, cb)Same as above but is called when someone stats a file descriptor
ops.flush(path, fd, cb)Called when a file descriptor is being flushed
ops.fsync(path, fd, datasync, cb)Called when a file descriptor is being fsync'ed.
ops.fsyncdir(path, fd, datasync, cb)Same as above but on a directory
ops.readdir(path, cb)Called when a directory is being listed. Accepts an array of file/directory names after the return code in the callback
ops.readdir = function (path, cb) {
cb(0, ['file-1.txt', 'dir'])
}
ops.truncate(path, size, cb)Called when a path is being truncated to a specific size
ops.ftruncate(path, fd, size, cb)Same as above but on a file descriptor
ops.readlink(path, cb)Called when a symlink is being resolved. Accepts a pathname (that the link should resolve to) after the return code in the callback
ops.readlink = function (path, cb) {
cb(null, 'file.txt') // make link point to file.txt
}
ops.chown(path, uid, gid, cb)Called when ownership of a path is being changed
ops.chmod(path, mode, cb)Called when the mode of a path is being changed
ops.mknod(path, mode, dev, cb)Called when the a new device file is being made.
ops.setxattr(path, name, buffer, length, offset, flags, cb)Called when extended attributes is being set (see the extended docs for your platform).
Currently you can read the attribute value being set in buffer at offset.
ops.getxattr(path, name, buffer, length, offset, cb)Called when extended attributes is being read.
Currently you have to write the result to the provided buffer at offset.
ops.open(path, flags, cb)Called when a path is being opened. flags in a number containing the permissions being requested. Accepts a file descriptor after the return code in the callback.
var toFlag = function(flags) {
flags = flags & 3
if (flags === 0) return 'r'
if (flags === 1) return 'w'
return 'r+'
}
ops.open = function (path, flags, cb) {
var flag = toFlag(flags) // convert flags to a node style string
...
cb(0, 42) // 42 is a file descriptor
}
ops.opendir(path, flags, cb)Same as above but for directories
ops.read(path, fd, buffer, length, position, cb)Called when contents of a file is being read. You should write the result of the read to the buffer and return the number of bytes written as the first argument in the callback.
If no bytes were written (read is complete) return 0 in the callback.
var data = new Buffer('hello world')
ops.read = function (path, fd, buffer, length, position, cb) {
if (position >= data.length) return cb(0) // done
var part = data.slice(position, position + length)
part.copy(buffer) // write the result of the read to the result buffer
cb(part.length) // return the number of bytes read
}
ops.write(path, fd, buffer, length, position, cb)Called when a file is being written to. You can get the data being written in buffer and you should return the number of bytes written in the callback as the first argument.
ops.write = function (path, fd, buffer, length, position, cb) {
console.log('writing', buffer.slice(0, length))
cb(length) // we handled all the data
}
ops.release(path, fd, cb)Called when a file descriptor is being released. Happens when a read/write is done etc.
ops.releasedir(path, fd, cb)Same as above but for directories
ops.create(path, mode, cb)Called when a new file is being opened.
ops.utimens(path, atime, mtime, cb)Called when the atime/mtime of a file is being changed.
ops.unlink(path, cb)Called when a file is being unlinked.
ops.rename(src, dest, cb)Called when a file is being renamed.
ops.link(src, dest, cb)Called when a new link is created.
ops.symlink(src, dest, cb)Called when a new symlink is created
ops.mkdir(path, mode, cb)Called when a new directory is being created
ops.rmdir(path, cb)Called when a directory is being removed
ops.destroy(cb)Both read and write passes the underlying fuse buffer without copying them to be as fast as possible.
The available error codes are exposes as well as properties. These include
fuse.EPERM === -1fuse.ENOENT === -2fuse.ESRCH === -3fuse.EINTR === -4fuse.EIO === -5fuse.ENXIO === -6fuse.E2BIG === -7fuse.ENOEXEC === -8fuse.EBADF === -9fuse.ECHILD === -10fuse.EAGAIN === -11fuse.ENOMEM === -12fuse.EACCES === -13fuse.EFAULT === -14fuse.ENOTBLK === -15fuse.EBUSY === -16fuse.EEXIST === -17fuse.EXDEV === -18fuse.ENODEV === -19fuse.ENOTDIR === -20fuse.EISDIR === -21fuse.EINVAL === -22fuse.ENFILE === -23fuse.EMFILE === -24fuse.ENOTTY === -25fuse.ETXTBSY === -26fuse.EFBIG === -27fuse.ENOSPC === -28fuse.ESPIPE === -29fuse.EROFS === -30fuse.EMLINK === -31fuse.EPIPE === -32fuse.EDOM === -33fuse.ERANGE === -34fuse.EDEADLK === -35fuse.ENAMETOOLONG === -36fuse.ENOLCK === -37fuse.ENOSYS === -38fuse.ENOTEMPTY === -39fuse.ELOOP === -40fuse.EWOULDBLOCK === -11fuse.ENOMSG === -42fuse.EIDRM === -43fuse.ECHRNG === -44fuse.EL2NSYNC === -45fuse.EL3HLT === -46fuse.EL3RST === -47fuse.ELNRNG === -48fuse.EUNATCH === -49fuse.ENOCSI === -50fuse.EL2HLT === -51fuse.EBADE === -52fuse.EBADR === -53fuse.EXFULL === -54fuse.ENOANO === -55fuse.EBADRQC === -56fuse.EBADSLT === -57fuse.EDEADLOCK === -35fuse.EBFONT === -59fuse.ENOSTR === -60fuse.ENODATA === -61fuse.ETIME === -62fuse.ENOSR === -63fuse.ENONET === -64fuse.ENOPKG === -65fuse.EREMOTE === -66fuse.ENOLINK === -67fuse.EADV === -68fuse.ESRMNT === -69fuse.ECOMM === -70fuse.EPROTO === -71fuse.EMULTIHOP === -72fuse.EDOTDOT === -73fuse.EBADMSG === -74fuse.EOVERFLOW === -75fuse.ENOTUNIQ === -76fuse.EBADFD === -77fuse.EREMCHG === -78fuse.ELIBACC === -79fuse.ELIBBAD === -80fuse.ELIBSCN === -81fuse.ELIBMAX === -82fuse.ELIBEXEC === -83fuse.EILSEQ === -84fuse.ERESTART === -85fuse.ESTRPIPE === -86fuse.EUSERS === -87fuse.ENOTSOCK === -88fuse.EDESTADDRREQ === -89fuse.EMSGSIZE === -90fuse.EPROTOTYPE === -91fuse.ENOPROTOOPT === -92fuse.EPROTONOSUPPORT === -93fuse.ESOCKTNOSUPPORT === -94fuse.EOPNOTSUPP === -95fuse.EPFNOSUPPORT === -96fuse.EAFNOSUPPORT === -97fuse.EADDRINUSE === -98fuse.EADDRNOTAVAIL === -99fuse.ENETDOWN === -100fuse.ENETUNREACH === -101fuse.ENETRESET === -102fuse.ECONNABORTED === -103fuse.ECONNRESET === -104fuse.ENOBUFS === -105fuse.EISCONN === -106fuse.ENOTCONN === -107fuse.ESHUTDOWN === -108fuse.ETOOMANYREFS === -109fuse.ETIMEDOUT === -110fuse.ECONNREFUSED === -111fuse.EHOSTDOWN === -112fuse.EHOSTUNREACH === -113fuse.EALREADY === -114fuse.EINPROGRESS === -115fuse.ESTALE === -116fuse.EUCLEAN === -117fuse.ENOTNAM === -118fuse.ENAVAIL === -119fuse.EISNAM === -120fuse.EREMOTEIO === -121fuse.EDQUOT === -122fuse.ENOMEDIUM === -123fuse.EMEDIUMTYPE === -124MIT
FAQs
Fully maintained fuse bindings for Node that aims to cover the entire FUSE api
The npm package fuse-bindings receives a total of 23 weekly downloads. As such, fuse-bindings popularity was classified as not popular.
We found that fuse-bindings demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.