@131/fuse-bindings 中文文档教程

Question

fuse-bindings

完全维护的 Node 融合绑定，旨在覆盖整个 FUSE

npm install fuse-bindings

api锁定）并且不做 读/写中的任何缓冲区副本。 它还支持多个保险丝驱动器的卸载和安装。

Requirements

您需要安装 FUSE（或 Windows 上的 Dokany）

• On Linux/Ubuntu sudo apt-get install libfuse-dev
• On OSX
• if you use Brew, install OSXFuse and brew install pkg-config
• if you use MacPorts, sudo port install osxfuse +devel
• On Windows install Dokany

Windows

警告：Dokany 仍然不太稳定。 它会导致蓝屏死机。 当心。

~~在Windows上使用这个稍微复杂一些。 您需要安装Dokany（用于dokanfuse.lib、dokanctl.exe, driver and service) and clone its repo (for the headers).~~

~~一旦Dokany repo被克隆，你还需要设置环境变量DOKAN_INSTALL_DIR到你的 Dokany 安装的 DokenLibrary 的路径，和 DOKAN_FUSE_INCLUDE 到 *dokany repo*\dokan_fuse\include 的路径。~~

编辑：Dokany 现在包含所需的标头并在安装时设置适当的环境变量！ 只需安装 Dokany，这个模块就可以正常安装和工作了！ （否则放弃问题）

Usage

尝试创建一个名为 mnt 的空文件夹并运行以下示例

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, pos + len)
    if (!str) return cb(0)
    buf.write(str)
    return cb(str.length)
  }
})

process.on('SIGINT', function () {
  fuse.unmount('./mnt', function (err) {
    if (err) throw err

    process.exit()
  })
})

API

fuse.mount(mnt, ops, [cb])

在 mnt 上安装一个新文件系统。 将您要支持的 FUSE 操作作为 ops 参数传递。

fuse.unmount(mnt, [cb])

卸载文件系统

fuse.context()

返回当前融合上下文（pid、uid、gid）。 必须在保险丝回调中调用。

Mount options

ops.options

设置 mount options

ops.options = ['direct_io'] // set the direct_io option

ops.displayFolder

设置为 true 使 OSX 显示文件夹图标和文件夹名称作为 finder 中的挂载点

ops.force

设置为 true 以强制挂载文件系统（将首先卸载）

FUSE operations

大多数 FUSE api 受支持。 一般来说，每个操作的回调应该用 cb(returnCode, [value]) 调用，其中返回码是一个数字（0 表示 OK，0 表示错误）。 请参阅下面的 POSIX 错误代码列表。

ops.init(cb)

在文件系统初始化时调用。

ops.access(path, mode, cb)

在文件系统访问文件之前

ops.statfs(path, cb)

调用在文件系统被统计时调用。 在回调中的返回码之后接受一个 fs stat 对象。

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)

在统计路径时调用。 在回调中的返回代码之后接受一个 stat 对象（类似于 fs.stat(path, cb) 中返回的对象）。

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)

与上面相同，但在有人统计文件描述符

ops.flush(path, fd, cb)

时调用在刷新文件描述符

ops.fsync(path, fd, datasync, cb)

时调用在文件描述符被 fsync 时调用。

ops.fsyncdir(path, fd, datasync, cb)

与上面相同，但在

ops.readdir(path, cb)

目录上 在列出目录时调用。 在回调中的返回代码之后接受文件/目录名称数组

ops.readdir = function (path, cb) {
  cb(0, ['file-1.txt', 'dir'])
}

ops.truncate(path, size, cb)

当路径被截断为特定大小

ops.ftruncate(path, fd, size, cb)

时调用与上面相同但在文件描述符

ops.readlink(path, cb)

上当解析符号链接时调用。 在回调中的返回码后接受路径名（链接应解析为） 在

ops.readlink = function (path, cb) {
  cb(null, 'file.txt') // make link point to file.txt
}

ops.chown(path, uid, gid, cb)

更改路径所有权时

ops.chmod(path, mode, cb)

调用 在更改路径模式时

ops.mknod(path, mode, dev, cb)

调用 在创建新设备文件时调用。

ops.setxattr(path, name, buffer, length, offset, flags, cb)

在设置扩展属性时调用（请参阅适用于您平台的扩展文档）。 目前，您可以在 offset 处读取 buffer 中设置的属性值。

ops.getxattr(path, name, buffer, length, offset, cb)

在读取扩展属性时调用。 目前，您必须将结果写入提供的 buffer 中的 offset。

ops.listxattr(path, buffer, length, cb)

在列出路径的扩展属性时调用。 buffer 应该用扩展属性名称填充为 null-terminated 字符串，一个接一个，直到总长度为 length。 （如果 length 不足，应将 ERANGE 传递给回调。） 成功时或提供的 length 为零时，应将保存所有名称所需的缓冲区大小传递给回调。

ops.removexattr(path, name, cb)

在删除扩展属性时调用。

ops.open(path, flags, cb)

打开路径时调用。 flags 包含所请求权限的数字。 在回调中的返回代码之后接受文件描述符。

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)

与上面相同，但用于目录

ops.read(path, fd, buffer, length, position, cb)

在读取文件内容时调用。 您应该将读取的结果写入 buffer 并返回写入的字节数作为回调中的第一个参数。 如果没有写入任何字节（读取完成），则在回调中返回 0。

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)

在写入文件时调用。 您可以获得正在写入 buffer 中的数据，您应该返回写入回调中的字节数作为第一个参数。

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)

在释放文件描述符时调用。 当读/写完成等时发生。

ops.releasedir(path, fd, cb)

与上面相同，但对于目录

ops.create(path, mode, cb)

在打开新文件时调用。

ops.utimens(path, atime, mtime, cb)

在更改文件的 atime/mtime 时调用。

ops.unlink(path, cb)

在取消链接文件时调用。

ops.rename(src, dest, cb)

重命名文件时调用。

ops.link(src, dest, cb)

创建新链接时调用。

ops.symlink(src, dest, cb)

在创建新符号链接

ops.mkdir(path, mode, cb)

时调用 在创建新目录

ops.rmdir(path, cb)

时调用 在删除目录时

ops.destroy(cb)

调用尽可能快。

Error codes

可用的错误代码是公开的以及属性。 其中包括

• fuse.EPERM === -1
• fuse.ENOENT === -2
• fuse.ESRCH === -3
• fuse.EINTR === -4
• fuse.EIO === -5
• fuse.ENXIO === -6
• fuse.E2BIG === -7
• fuse.ENOEXEC === -8
• fuse.EBADF === -9
• fuse.ECHILD === -10
• fuse.EAGAIN === -11
• fuse.ENOMEM === -12
• fuse.EACCES === -13
• fuse.EFAULT === -14
• fuse.ENOTBLK === -15
• fuse.EBUSY === -16
• fuse.EEXIST === -17
• fuse.EXDEV === -18
• fuse.ENODEV === -19
• fuse.ENOTDIR === -20
• fuse.EISDIR === -21
• fuse.EINVAL === -22
• fuse.ENFILE === -23
• fuse.EMFILE === -24
• fuse.ENOTTY === -25
• fuse.ETXTBSY === -26
• fuse.EFBIG === -27
• fuse.ENOSPC === -28
• fuse.ESPIPE === -29
• fuse.EROFS === -30
• fuse.EMLINK === -31
• fuse.EPIPE === -32
• fuse.EDOM === -33
• fuse.ERANGE === -34
• fuse.EDEADLK === -35
• fuse.ENAMETOOLONG === -36
• fuse.ENOLCK === -37
• fuse.ENOSYS === -38
• fuse.ENOTEMPTY === -39
• fuse.ELOOP === -40
• fuse.EWOULDBLOCK === -11
• fuse.ENOMSG === -42
• fuse.EIDRM === -43
• fuse.ECHRNG === -44
• fuse.EL2NSYNC === -45
• fuse.EL3HLT === -46
• fuse.EL3RST === -47
• fuse.ELNRNG === -48
• fuse.EUNATCH === -49
• fuse.ENOCSI === -50
• fuse.EL2HLT === -51
• fuse.EBADE === -52
• fuse.EBADR === -53
• fuse.EXFULL === -54
• fuse.ENOANO === -55
• fuse.EBADRQC === -56
• fuse.EBADSLT === -57
• fuse.EDEADLOCK === -35
• fuse.EBFONT === -59
• fuse.ENOSTR === -60
• fuse.ENODATA === -61
• fuse.ETIME === -62
• fuse.ENOSR === -63
• fuse.ENONET === -64
• fuse.ENOPKG === -65
• fuse.EREMOTE === -66
• fuse.ENOLINK === -67
• fuse.EADV === -68
• fuse.ESRMNT === -69
• fuse.ECOMM === -70
• fuse.EPROTO === -71
• fuse.EMULTIHOP === -72
• fuse.EDOTDOT === -73
• fuse.EBADMSG === -74
• fuse.EOVERFLOW === -75
• fuse.ENOTUNIQ === -76
• fuse.EBADFD === -77
• fuse.EREMCHG === -78
• fuse.ELIBACC === -79
• fuse.ELIBBAD === -80
• fuse.ELIBSCN === -81
• fuse.ELIBMAX === -82
• fuse.ELIBEXEC === -83
• fuse.EILSEQ === -84
• fuse.ERESTART === -85
• fuse.ESTRPIPE === -86
• fuse.EUSERS === -87
• fuse.ENOTSOCK === -88
• fuse.EDESTADDRREQ === -89
• fuse.EMSGSIZE === -90
• fuse.EPROTOTYPE === -91
• fuse.ENOPROTOOPT === -92
• fuse.EPROTONOSUPPORT === -93
• fuse.ESOCKTNOSUPPORT === -94
• fuse.EOPNOTSUPP === -95
• fuse.EPFNOSUPPORT === -96
• fuse.EAFNOSUPPORT === -97
• fuse.EADDRINUSE === -98
• fuse.EADDRNOTAVAIL === -99
• fuse.ENETDOWN === -100
• fuse.ENETUNREACH === -101
• fuse.ENETRESET === -102
• fuse.ECONNABORTED === -103
• fuse.ECONNRESET === -104
• fuse.ENOBUFS === -105
• fuse.EISCONN === -106
• fuse.ENOTCONN === -107
• fuse.ESHUTDOWN === -108
• fuse.ETOOMANYREFS === -109
• fuse.ETIMEDOUT === -110
• fuse.ECONNREFUSED === -111
• fuse.EHOSTDOWN === -112
• fuse.EHOSTUNREACH === -113
• fuse.EALREADY === -114
• fuse.EINPROGRESS === -115
• fuse.ESTALE === -116
• fuse.EUCLEAN === -117
• fuse.ENOTNAM === -118
• fuse.ENAVAIL === -119
• fuse.EISNAM === -120
• fuse.EREMOTEIO === -121
• fuse.EDQUOT === -122
• fuse.ENOMEDIUM === -123
• fuse.EMEDIUMTYPE === -124

License

麻省理工学院