simplefs

package
v2.11.3+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2021 License: BSD-3-Clause Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewSimpleFS 

func NewSimpleFS(appStateUpdater env.AppStateUpdater, config libkbfs.Config) keybase1.SimpleFSInterface

NewSimpleFS creates a new SimpleFS instance.

func Quarantine 

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

Quarantine is for adding the mark of the web

Types

type SimpleFS 

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

SimpleFS is the simple filesystem rpc layer implementation.

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(
	_ context.Context, _ libkbfs.Node, _ libkbfs.WriteRange)

LocalChange implements the libkbfs.Observer interface for SimpleFS.

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) SimpleFSCheck 

func (k *SimpleFS) SimpleFSCheck(_ 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) SimpleFSClose 

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

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

func (*SimpleFS) SimpleFSCopy 

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

SimpleFSCopy - Begin copy of file or directory

func (*SimpleFS) SimpleFSCopyRecursive 

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

SimpleFSCopyRecursive - Begin recursive copy of directory

func (*SimpleFS) SimpleFSDumpDebuggingInfo added in v1.0.47 

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

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

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, error)

SimpleFSFolderSyncConfigAndStatus gets the given folder's sync config.

func (*SimpleFS) SimpleFSGetHTTPAddressAndToken added in v1.0.48 

func (k *SimpleFS) SimpleFSGetHTTPAddressAndToken(ctx context.Context) (
	resp keybase1.SimpleFSGetHTTPAddressAndTokenResponse, err error)

SimpleFSGetHTTPAddressAndToken returns a random token to be used for the local KBFS http server.

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) 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) 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) SimpleFSListRecursive 

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

SimpleFSListRecursive - Begin recursive list of items in directory at path

func (*SimpleFS) SimpleFSListRecursiveToDepth 

func (k *SimpleFS) SimpleFSListRecursiveToDepth(ctx context.Context, arg keybase1.SimpleFSListRecursiveToDepthArg) 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) SimpleFSMove 

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

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

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) 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, path keybase1.Path) error

SimpleFSReset resets the given TLF.

func (*SimpleFS) SimpleFSSetFolderSyncConfig 

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

SimpleFSSetFolderSyncConfig 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) SimpleFSStat 

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

SimpleFSStat - Get info about file 

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

SimpleFSSymlink starts making a symlink of a file or directory

func (*SimpleFS) SimpleFSSyncStatus added in v1.0.48 

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

SimpleFSSyncStatus - Get sync status.

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) 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) error

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

func (*SimpleFS) TlfHandleChange 

func (k *SimpleFS) TlfHandleChange(_ context.Context, _ *libkbfs.TlfHandle)

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.