simplefs

package
v0.0.0-...-34cb6d9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 18, 2024 License: BSD-3-Clause, BSD-3-Clause Imports: 49 Imported by: 12

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Quarantine 

func Quarantine(ctx context.Context, path string) error

Quarantine is for adding the mark of the web.

Types

type Receipt 

type Receipt struct {
	Desc     keybase1.SimpleFSArchiveJobDesc
	Manifest map[string]keybase1.SimpleFSArchiveFile
}

Receipt is serialized into receipt.json in the archive.

type SimpleFS 

type SimpleFS struct {
	// contains filtered or unexported fields
}

SimpleFS is the simple filesystem rpc layer implementation.

func NewSimpleFS 

func NewSimpleFS(
	appStateUpdater env.AppStateUpdater, config libkbfs.Config) (
	iface *SimpleFS,
	shutdownFn func(context.Context) error)

NewSimpleFS creates a new SimpleFS instance.

func (*SimpleFS) BatchChanges 

func (k *SimpleFS) BatchChanges(
	ctx context.Context, changes []libkbfs.NodeChange, _ []libkbfs.NodeID)

BatchChanges implements the libkbfs.Observer interface for SimpleFS.

func (*SimpleFS) LocalChange 

func (k *SimpleFS) LocalChange(
	ctx context.Context, node libkbfs.Node, _ libkbfs.WriteRange)

LocalChange implements the libkbfs.Observer interface for SimpleFS.

func (*SimpleFS) ResetForLogin 

func (k *SimpleFS) ResetForLogin(ctx context.Context,
	username libkb.NormalizedUsername) (err error)

ResetForLogin (partially) resets simplefs state when user logs out.

func (*SimpleFS) Shutdown 

func (k *SimpleFS) Shutdown(ctx context.Context) error

Shutdown shuts down SimpleFS.

func (*SimpleFS) SimpleFSArchiveAllFiles 

func (k *SimpleFS) SimpleFSArchiveAllFiles(
	ctx context.Context, arg keybase1.SimpleFSArchiveAllFilesArg) (
	res keybase1.SimpleFSArchiveAllFilesResult, err error)

SimpleFSArchiveAllFiles implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSArchiveAllGitRepos 

func (k *SimpleFS) SimpleFSArchiveAllGitRepos(
	ctx context.Context, arg keybase1.SimpleFSArchiveAllGitReposArg) (
	res keybase1.SimpleFSArchiveAllGitReposResult, err error)

SimpleFSArchiveAllGitRepos implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSArchiveCancelOrDismissJob 

func (k *SimpleFS) SimpleFSArchiveCancelOrDismissJob(ctx context.Context,
	jobID string) (err error)

SimpleFSArchiveCancelOrDismissJob implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSArchiveCheckArchive 

func (k *SimpleFS) SimpleFSArchiveCheckArchive(ctx context.Context,
	archiveZipFilePath string) (result keybase1.SimpleFSArchiveCheckArchiveResult, err error)

SimpleFSArchiveCheckArchive implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSArchiveStart 

func (k *SimpleFS) SimpleFSArchiveStart(ctx context.Context,
	arg keybase1.SimpleFSArchiveStartArg) (jobDesc keybase1.SimpleFSArchiveJobDesc, err error)

SimpleFSArchiveStart implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSCancel 

func (k *SimpleFS) SimpleFSCancel(_ context.Context, opid keybase1.OpID) error

SimpleFSCancel starts to cancel op with the given opid. Also remove any pending references of opid everywhere. Returns before cancellation is guaranteeded to be done - that may take some time. Currently always returns nil.

func (*SimpleFS) SimpleFSCancelDownload 

func (k *SimpleFS) SimpleFSCancelDownload(
	ctx context.Context, downloadID string) (err error)

SimpleFSCancelDownload implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSCancelJournalUploads 

func (k *SimpleFS) SimpleFSCancelJournalUploads(
	ctx context.Context, path keybase1.KBFSPath) (err error)

SimpleFSCancelJournalUploads implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSCancelUpload 

func (k *SimpleFS) SimpleFSCancelUpload(
	ctx context.Context, uploadID string) (err error)

SimpleFSCancelUpload implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSCheck 

func (k *SimpleFS) SimpleFSCheck(
	ctx context.Context, opid keybase1.OpID) (keybase1.OpProgress, error)

SimpleFSCheck - Check progress of pending operation Progress variable is still TBD. Return errNoResult if no operation found.

func (*SimpleFS) SimpleFSCheckReachability 

func (k *SimpleFS) SimpleFSCheckReachability(ctx context.Context) error

SimpleFSCheckReachability implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSClearConflictState 

func (k *SimpleFS) SimpleFSClearConflictState(ctx context.Context,
	path keybase1.Path) (err error)

SimpleFSClearConflictState implements the SimpleFS interface.

func (*SimpleFS) SimpleFSClose 

func (k *SimpleFS) SimpleFSClose(ctx context.Context, opid keybase1.OpID) (err error)

SimpleFSClose - Close removes a handle associated with Open / List.

func (*SimpleFS) SimpleFSConfigureDownload 

func (k *SimpleFS) SimpleFSConfigureDownload(
	ctx context.Context, arg keybase1.SimpleFSConfigureDownloadArg) (err error)

SimpleFSConfigureDownload implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSCopy 

func (k *SimpleFS) SimpleFSCopy(
	ctx context.Context, arg keybase1.SimpleFSCopyArg) (err error)

SimpleFSCopy - Begin copy of file or directory

func (*SimpleFS) SimpleFSCopyRecursive 

func (k *SimpleFS) SimpleFSCopyRecursive(ctx context.Context,
	arg keybase1.SimpleFSCopyRecursiveArg) (err error)

SimpleFSCopyRecursive - Begin recursive copy of directory

func (*SimpleFS) SimpleFSDeobfuscatePath 

func (k *SimpleFS) SimpleFSDeobfuscatePath(
	ctx context.Context, path keybase1.Path) (res []string, err error)

SimpleFSDeobfuscatePath implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSDismissDownload 

func (k *SimpleFS) SimpleFSDismissDownload(
	ctx context.Context, downloadID string) (err error)

SimpleFSDismissDownload implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSDismissUpload 

func (k *SimpleFS) SimpleFSDismissUpload(
	ctx context.Context, uploadID string) (err error)

SimpleFSDismissUpload implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSDumpDebuggingInfo 

func (k *SimpleFS) SimpleFSDumpDebuggingInfo(ctx context.Context) error

SimpleFSDumpDebuggingInfo - Instructs KBFS to dump debugging info into its logs.

func (*SimpleFS) SimpleFSFinishResolvingConflict 

func (k *SimpleFS) SimpleFSFinishResolvingConflict(ctx context.Context,
	path keybase1.Path) (err error)

SimpleFSFinishResolvingConflict implements the SimpleFS interface.

func (*SimpleFS) SimpleFSFolderEditHistory 

func (k *SimpleFS) SimpleFSFolderEditHistory(
	ctx context.Context, path keybase1.Path) (
	res keybase1.FSFolderEditHistory, err error)

SimpleFSFolderEditHistory returns the edit history for the given TLF.

func (*SimpleFS) SimpleFSFolderSyncConfigAndStatus 

func (k *SimpleFS) SimpleFSFolderSyncConfigAndStatus(
	ctx context.Context, path keybase1.Path) (
	_ keybase1.FolderSyncConfigAndStatus, err error)

SimpleFSFolderSyncConfigAndStatus gets the given folder's sync config.

func (*SimpleFS) SimpleFSForceStuckConflict 

func (k *SimpleFS) SimpleFSForceStuckConflict(
	ctx context.Context, path keybase1.Path) (err error)

SimpleFSForceStuckConflict implements the SimpleFS interface.

func (*SimpleFS) SimpleFSGetArchiveJobFreshness 

func (k *SimpleFS) SimpleFSGetArchiveJobFreshness(ctx context.Context, jobID string) (keybase1.SimpleFSArchiveJobFreshness, error)

SimpleFSGetArchiveJobFreshness implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetArchiveStatus 

func (k *SimpleFS) SimpleFSGetArchiveStatus(ctx context.Context) (
	status keybase1.SimpleFSArchiveStatus, err error)

SimpleFSGetArchiveStatus implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetDownloadInfo 

func (k *SimpleFS) SimpleFSGetDownloadInfo(
	ctx context.Context, downloadID string) (
	downloadInfo keybase1.DownloadInfo, err error)

SimpleFSGetDownloadInfo implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetDownloadStatus 

func (k *SimpleFS) SimpleFSGetDownloadStatus(ctx context.Context) (
	status keybase1.DownloadStatus, err error)

SimpleFSGetDownloadStatus implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetFilesTabBadge 

func (k *SimpleFS) SimpleFSGetFilesTabBadge(ctx context.Context) (
	keybase1.FilesTabBadge, error)

SimpleFSGetFilesTabBadge implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetFolder 

func (k *SimpleFS) SimpleFSGetFolder(
	ctx context.Context, kbfsPath keybase1.KBFSPath) (
	res keybase1.FolderWithFavFlags, err error)

SimpleFSGetFolder implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetGUIFileContext 

func (k *SimpleFS) SimpleFSGetGUIFileContext(ctx context.Context,
	kbfsPath keybase1.KBFSPath) (resource keybase1.GUIFileContext, err error)

SimpleFSGetGUIFileContext implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetIndexProgress 

func (k *SimpleFS) SimpleFSGetIndexProgress(
	ctx context.Context) (res keybase1.SimpleFSIndexProgress, err error)

SimpleFSGetIndexProgress implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetOnlineStatus 

func (k *SimpleFS) SimpleFSGetOnlineStatus(
	ctx context.Context, clientID string) (keybase1.KbfsOnlineStatus, error)

SimpleFSGetOnlineStatus implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetOps 

func (k *SimpleFS) SimpleFSGetOps(_ context.Context) ([]keybase1.OpDescription, error)

SimpleFSGetOps - Get all the outstanding operations

func (*SimpleFS) SimpleFSGetRevisions 

func (k *SimpleFS) SimpleFSGetRevisions(
	ctx context.Context, arg keybase1.SimpleFSGetRevisionsArg) (err error)

SimpleFSGetRevisions - Get revisions for a file

func (*SimpleFS) SimpleFSGetStats 

func (k *SimpleFS) SimpleFSGetStats(ctx context.Context) (
	res keybase1.SimpleFSStats, err error)

SimpleFSGetStats implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetTeamQuotaUsage 

func (k *SimpleFS) SimpleFSGetTeamQuotaUsage(
	ctx context.Context, teamName keybase1.TeamName) (
	res keybase1.SimpleFSQuotaUsage, err error)

SimpleFSGetTeamQuotaUsage returns the quota usage information for the given team.

func (*SimpleFS) SimpleFSGetUploadStatus 

func (k *SimpleFS) SimpleFSGetUploadStatus(
	ctx context.Context) (status []keybase1.UploadState, err error)

SimpleFSGetUploadStatus implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSGetUserQuotaUsage 

func (k *SimpleFS) SimpleFSGetUserQuotaUsage(ctx context.Context) (
	res keybase1.SimpleFSQuotaUsage, err error)

SimpleFSGetUserQuotaUsage returns the quota usage information for the logged-in user.

func (*SimpleFS) SimpleFSList 

func (k *SimpleFS) SimpleFSList(ctx context.Context, arg keybase1.SimpleFSListArg) (err error)

SimpleFSList - Begin list of items in directory at path Retrieve results with readList() Cannot be a single file to get flags/status, must be a directory.

func (*SimpleFS) SimpleFSListFavorites 

func (k *SimpleFS) SimpleFSListFavorites(ctx context.Context) (
	keybase1.FavoritesResult, error)

SimpleFSListFavorites lists the favorite, new, and ignored folders of the logged in user, getting its data from the KBFS Favorites cache. If the cache is stale, this will trigger a network request.

func (*SimpleFS) SimpleFSListRecursive 

func (k *SimpleFS) SimpleFSListRecursive(
	ctx context.Context, arg keybase1.SimpleFSListRecursiveArg) (err error)

SimpleFSListRecursive - Begin recursive list of items in directory at path

func (*SimpleFS) SimpleFSListRecursiveToDepth 

func (k *SimpleFS) SimpleFSListRecursiveToDepth(
	ctx context.Context, arg keybase1.SimpleFSListRecursiveToDepthArg) (err error)

SimpleFSListRecursiveToDepth - Begin recursive list of items in directory at path up to a given depth.

func (*SimpleFS) SimpleFSMakeOpid 

func (k *SimpleFS) SimpleFSMakeOpid(_ context.Context) (keybase1.OpID, error)

SimpleFSMakeOpid - Convenience helper for generating new random value

func (*SimpleFS) SimpleFSMakeTempDirForUpload 

func (k *SimpleFS) SimpleFSMakeTempDirForUpload(
	ctx context.Context) (dirPath string, err error)

SimpleFSMakeTempDirForUpload implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSMove 

func (k *SimpleFS) SimpleFSMove(
	ctx context.Context, arg keybase1.SimpleFSMoveArg) (err error)

SimpleFSMove - Begin move of file or directory, from/to KBFS only

func (*SimpleFS) SimpleFSObfuscatePath 

func (k *SimpleFS) SimpleFSObfuscatePath(
	ctx context.Context, path keybase1.Path) (res string, err error)

SimpleFSObfuscatePath implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSOpen 

func (k *SimpleFS) SimpleFSOpen(
	ctx context.Context, arg keybase1.SimpleFSOpenArg) (err error)

SimpleFSOpen - Create/open a file and leave it open or create a directory Files must be closed afterwards.

func (*SimpleFS) SimpleFSRead 

func (k *SimpleFS) SimpleFSRead(ctx context.Context,
	arg keybase1.SimpleFSReadArg) (_ keybase1.FileContent, err error)

SimpleFSRead - Read (possibly partial) contents of open file, up to the amount specified by size. Repeat until zero bytes are returned or error. If size is zero, read an arbitrary amount.

func (*SimpleFS) SimpleFSReadList 

func (k *SimpleFS) SimpleFSReadList(_ context.Context, opid keybase1.OpID) (keybase1.SimpleFSListResult, error)

SimpleFSReadList - Get list of Paths in progress. Can indicate status of pending to get more entries.

func (*SimpleFS) SimpleFSReadRevisions 

func (k *SimpleFS) SimpleFSReadRevisions(
	_ context.Context, opid keybase1.OpID) (
	keybase1.GetRevisionsResult, error)

SimpleFSReadRevisions - Get list of revisions in progress. Can indicate status of pending to get more revisions.

func (*SimpleFS) SimpleFSRemove 

func (k *SimpleFS) SimpleFSRemove(ctx context.Context,
	arg keybase1.SimpleFSRemoveArg) (err error)

SimpleFSRemove - Remove file or directory from filesystem

func (*SimpleFS) SimpleFSRename 

func (k *SimpleFS) SimpleFSRename(
	ctx context.Context, arg keybase1.SimpleFSRenameArg) (err error)

SimpleFSRename - Rename file or directory, KBFS side only

func (*SimpleFS) SimpleFSReset 

func (k *SimpleFS) SimpleFSReset(
	ctx context.Context, arg keybase1.SimpleFSResetArg) error

SimpleFSReset resets the given TLF.

func (*SimpleFS) SimpleFSResetIndex 

func (k *SimpleFS) SimpleFSResetIndex(ctx context.Context) error

SimpleFSResetIndex implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSearch 

func (k *SimpleFS) SimpleFSSearch(
	ctx context.Context, arg keybase1.SimpleFSSearchArg) (
	res keybase1.SimpleFSSearchResults, err error)

SimpleFSSearch implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSetDebugLevel 

func (k *SimpleFS) SimpleFSSetDebugLevel(
	_ context.Context, level string) error

SimpleFSSetDebugLevel implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSetFolderSyncConfig 

func (k *SimpleFS) SimpleFSSetFolderSyncConfig(
	ctx context.Context, arg keybase1.SimpleFSSetFolderSyncConfigArg) (err error)

SimpleFSSetFolderSyncConfig implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSetNotificationThreshold 

func (k *SimpleFS) SimpleFSSetNotificationThreshold(ctx context.Context, threshold int64) (err error)

SimpleFSSetNotificationThreshold implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSetSfmiBannerDismissed 

func (k *SimpleFS) SimpleFSSetSfmiBannerDismissed(
	ctx context.Context, dismissed bool) (err error)

SimpleFSSetSfmiBannerDismissed implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSetStat 

func (k *SimpleFS) SimpleFSSetStat(
	ctx context.Context, arg keybase1.SimpleFSSetStatArg) (err error)

SimpleFSSetStat - Set/clear file bits - only executable for now

func (*SimpleFS) SimpleFSSetSyncOnCellular 

func (k *SimpleFS) SimpleFSSetSyncOnCellular(
	ctx context.Context, syncOnCellular bool) (err error)

SimpleFSSetSyncOnCellular implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSettings 

func (k *SimpleFS) SimpleFSSettings(ctx context.Context) (settings keybase1.FSSettings, err error)

SimpleFSSettings implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSStartDownload 

func (k *SimpleFS) SimpleFSStartDownload(
	ctx context.Context, arg keybase1.SimpleFSStartDownloadArg) (
	downloadID string, err error)

SimpleFSStartDownload implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSStartUpload 

func (k *SimpleFS) SimpleFSStartUpload(ctx context.Context,
	arg keybase1.SimpleFSStartUploadArg) (uploadID string, err error)

SimpleFSStartUpload implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSStat 

func (k *SimpleFS) SimpleFSStat(ctx context.Context, arg keybase1.SimpleFSStatArg) (de keybase1.Dirent, err error)

SimpleFSStat - Get info about file

func (*SimpleFS) SimpleFSSubscribeNonPath 

func (k *SimpleFS) SimpleFSSubscribeNonPath(
	ctx context.Context, arg keybase1.SimpleFSSubscribeNonPathArg) (err error)

SimpleFSSubscribeNonPath implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSubscribePath 

func (k *SimpleFS) SimpleFSSubscribePath(
	ctx context.Context, arg keybase1.SimpleFSSubscribePathArg) (err error)

SimpleFSSubscribePath implements the SimpleFSInterface. 

func (k *SimpleFS) SimpleFSSymlink(
	ctx context.Context, arg keybase1.SimpleFSSymlinkArg) (err error)

SimpleFSSymlink starts making a symlink of a file or directory

func (*SimpleFS) SimpleFSSyncConfigAndStatus 

func (k *SimpleFS) SimpleFSSyncConfigAndStatus(ctx context.Context,
	identifyBehavior *keybase1.TLFIdentifyBehavior) (
	res keybase1.SyncConfigAndStatusRes, err error)

SimpleFSSyncConfigAndStatus implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSSyncStatus 

func (k *SimpleFS) SimpleFSSyncStatus(ctx context.Context, filter keybase1.ListFilter) (keybase1.FSSyncStatus, error)

SimpleFSSyncStatus - Get sync status.

func (*SimpleFS) SimpleFSUnsubscribe 

func (k *SimpleFS) SimpleFSUnsubscribe(
	ctx context.Context, arg keybase1.SimpleFSUnsubscribeArg) (err error)

SimpleFSUnsubscribe implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSUserEditHistory 

func (k *SimpleFS) SimpleFSUserEditHistory(ctx context.Context) (
	res []keybase1.FSFolderEditHistory, err error)

SimpleFSUserEditHistory returns the edit history for the logged-in user.

func (*SimpleFS) SimpleFSUserIn 

func (k *SimpleFS) SimpleFSUserIn(ctx context.Context, clientID string) error

SimpleFSUserIn implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSUserOut 

func (k *SimpleFS) SimpleFSUserOut(ctx context.Context, clientID string) error

SimpleFSUserOut implements the SimpleFSInterface.

func (*SimpleFS) SimpleFSWait 

func (k *SimpleFS) SimpleFSWait(ctx context.Context, opid keybase1.OpID) error

SimpleFSWait - Blocking wait for the pending operation to finish

func (*SimpleFS) SimpleFSWrite 

func (k *SimpleFS) SimpleFSWrite(
	ctx context.Context, arg keybase1.SimpleFSWriteArg) (err error)

SimpleFSWrite - Append content to opened file. May be repeated until OpID is closed.

func (*SimpleFS) TlfHandleChange 

func (k *SimpleFS) TlfHandleChange(_ context.Context, _ *tlfhandle.Handle)

TlfHandleChange implements the libkbfs.Observer interface for SimpleFS.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.