# README
Library code gluing together KBFS and the FUSE protocol.
(TODO: Fill in more details.)
# Functions
AddPlatformFlags adds platform-specific flags to the given FlagSet and returns a PlatformParams object that will be filled in when the given FlagSet is parsed.
GetPlatformSpecificMountOptionsForTest makes cross-platform tests work.
GetPlatformUsageString returns a string to be included in a usage string corresponding to the flags added by AddPlatformFlags.
MakeFuseDebugFn returns a function that logs its argument to the given log, suitable to assign to fuse.Debug.
MakeFuseVDebugFn returns a function that logs its argument to the given vlog at level 1, suitable to assign to fuse.Debug.
NewArchiveRelTimeFile returns a special read file that contains a by-revision directory name that corresponds to the given relative time string for the given folder.
NewErrorFile returns a special read file that contains a text representation of the last few KBFS errors.
NewFileInfoFile returns a special file that contains a text representation of a file's KBFS metadata.
NewFS creates an FS.
NewMetricsFile returns a special read file that contains a text representation of all metrics.
NewNonTLFStatusFile returns a special read file that contains a text representation of the global KBFS status.
NewQuarantineXattrHandler returns a handler that doesn't handle Xattr calls on this platform.
NewTlfEditHistoryFile returns a special read file that contains a text representation of the file edit history for that TLF.
NewUpdateHistoryFile returns a special read file that contains a text representation of the update history of the current TLF.
NewUserEditHistoryFile returns a special read file that contains a text representation of the file edit history for the logged-in user.
Start the filesystem.
# Constants
CtxIDKey is the type of the tag for unique operation IDs.
CtxOpID is the display name for the unique operation FUSE ID tag.
PrivateName is the name of the parent of all private top-level folders.
PublicName is the name of the parent of all public top-level folders.
TeamName is the name of the parent of all team top-level folders.
# Structs
Alias represents an alias.
DebugServerFile represents a write-only file where any write of at least one byte triggers either disabling or enabling the debug server.
Dir represents a subdirectory of a KBFS top-level folder (including the TLF root directory itself).
File represents KBFS files.
Folder represents the info shared among all nodes of a KBFS top-level folder.
FolderList is a node that can list all of the logged-in user's favorite top-level folders, on either a public or private basis.
FS implements the newfuse FS interface for KBFS.
JournalControlFile is a special file used to control journal settings.
NoXattrHandler is a Xattr handler that always returns fuse.ENOTSUP.
PlatformParams contains all platform-specific parameters to be passed to New{Default,Force}Mounter.
PrefetchFile represents a write-only file where any write of at least one byte triggers either disabling or enabling prefetching.
ProfileList is a node that can list all of the available profiles.
ReclaimQuotaFile represents a write-only file when any write of at least one byte triggers a quota reclamation of the folder.
RekeyFile represents a write-only file when any write of at least one byte triggers a rekey of the folder.
ResetCachesFile represents a write-only file where any write of at least one byte triggers the resetting of all data caches.
Root represents the root of the KBFS file system.
SpecialReadFile represents a file whose contents are determined by a function.
StartOptions are options for starting up.
Symlink represents KBFS symlinks.
SyncControlFile is a special file used to control sync settings.
SyncFromServerFile represents a write-only file when any write of at least one byte triggers a sync of the folder from the server.
TLF represents the root directory of a TLF.
UnstageFile represents a write-only file when any write of at least one byte triggers unstaging all unmerged commits and fast-forwarding to the current master.
UpdatesFile represents a write-only file where any write of at least one byte triggers either disabling remote folder updates and conflict resolution, or re-enabling both.
# Interfaces
DirInterface gathers all the interfaces a Dir or something that wraps a Dir should implement.
XattrHandler is an interface that includes fuse Get/Set/Remove calls for xattr.
# Type aliases
CtxTagKey is the type used for unique context tags.