# README
Library code gluing together KBFS and the Dokan protocol.
(TODO: Fill in more details.)
# Functions
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.
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 Dokan ID tag.
DefaultMountFlags are the default mount flags for libdokan.
HiddenFilePrefix is the prefix for files to be hidden.
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.
WrongUserErrorContents is the contents of the file.
WrongUserErrorFileName is the name of error directory for other users.
# Structs
Alias is a top-level folder accessed through its non-canonical name.
Dir represents KBFS subdirectories.
EmptyFolder represents an empty, read-only KBFS TLF that has not been created by someone with sufficient permissions.
File represents KBFS files.
Folder represents KBFS top-level folders.
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.
FSO is a common type for file system objects, i.e.
JournalControlFile is a special file used to control journal settings.
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.
# Type aliases
CtxTagKey is the type used for unique context tags.