Commit b20262de authored by Han-Wen Nienhuys's avatar Han-Wen Nienhuys

fuse: add more docs to api.go

parent 51f7cee9
// The fuse package provides APIs to implement filesystems in // The fuse package provides APIs to implement filesystems in
// userspace. Typically, each call of the API happens in its own // userspace. Typically, each call of the API happens in its own
// goroutine, so take care to make the file system thread-safe. // goroutine, so take care to make the file system thread-safe.
package fuse package fuse
import ( import (
...@@ -18,8 +17,18 @@ import ( ...@@ -18,8 +17,18 @@ import (
// to represent fits in memory: you can construct FsNode at mount // to represent fits in memory: you can construct FsNode at mount
// time, and the filesystem will be ready. // time, and the filesystem will be ready.
type NodeFileSystem interface { type NodeFileSystem interface {
// OnUnmount is executed just before a submount is removed,
// and when the process receives a forget for the FUSE root
// node.
OnUnmount() OnUnmount()
// OnMount is called just after a mount is executed, either
// when the root is mounted, or when other filesystem are
// mounted in-process. The passed-in FileSystemConnector gives
// access to Notify methods and Debug settings.
OnMount(conn *FileSystemConnector) OnMount(conn *FileSystemConnector)
// Root should return the inode for root of this file system.
Root() FsNode Root() FsNode
// Used for debug outputs // Used for debug outputs
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment