Documentation
¶
Index ¶
- func NewSimpleFS(g *libkb.GlobalContext, config libkbfs.Config) keybase1.SimpleFSInterface
- type SimpleFS
- func (k *SimpleFS) SimpleFSCancel(_ context.Context, opid keybase1.OpID) error
- func (k *SimpleFS) SimpleFSCheck(_ context.Context, opid keybase1.OpID) (keybase1.OpProgress, error)
- func (k *SimpleFS) SimpleFSClose(ctx context.Context, opid keybase1.OpID) (err error)
- func (k *SimpleFS) SimpleFSCopy(ctx context.Context, arg keybase1.SimpleFSCopyArg) error
- func (k *SimpleFS) SimpleFSCopyRecursive(ctx context.Context, arg keybase1.SimpleFSCopyRecursiveArg) error
- func (k *SimpleFS) SimpleFSDumpDebuggingInfo(ctx context.Context) error
- func (k *SimpleFS) SimpleFSGetHTTPAddressAndToken(ctx context.Context) (resp keybase1.SimpleFSGetHTTPAddressAndTokenResponse, err error)
- func (k *SimpleFS) SimpleFSGetOps(_ context.Context) ([]keybase1.OpDescription, error)
- func (k *SimpleFS) SimpleFSList(ctx context.Context, arg keybase1.SimpleFSListArg) error
- func (k *SimpleFS) SimpleFSListRecursive(ctx context.Context, arg keybase1.SimpleFSListRecursiveArg) error
- func (k *SimpleFS) SimpleFSMakeOpid(_ context.Context) (keybase1.OpID, error)
- func (k *SimpleFS) SimpleFSMove(ctx context.Context, arg keybase1.SimpleFSMoveArg) error
- func (k *SimpleFS) SimpleFSOpen(ctx context.Context, arg keybase1.SimpleFSOpenArg) (err error)
- func (k *SimpleFS) SimpleFSRead(ctx context.Context, arg keybase1.SimpleFSReadArg) (_ keybase1.FileContent, err error)
- func (k *SimpleFS) SimpleFSReadList(_ context.Context, opid keybase1.OpID) (keybase1.SimpleFSListResult, error)
- func (k *SimpleFS) SimpleFSRemove(ctx context.Context, arg keybase1.SimpleFSRemoveArg) error
- func (k *SimpleFS) SimpleFSRename(ctx context.Context, arg keybase1.SimpleFSRenameArg) (err error)
- func (k *SimpleFS) SimpleFSSetStat(ctx context.Context, arg keybase1.SimpleFSSetStatArg) (err error)
- func (k *SimpleFS) SimpleFSStat(ctx context.Context, path keybase1.Path) (de keybase1.Dirent, err error)
- func (k *SimpleFS) SimpleFSSyncStatus(ctx context.Context) (keybase1.FSSyncStatus, error)
- func (k *SimpleFS) SimpleFSWait(ctx context.Context, opid keybase1.OpID) error
- func (k *SimpleFS) SimpleFSWrite(ctx context.Context, arg keybase1.SimpleFSWriteArg) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewSimpleFS ¶
func NewSimpleFS(g *libkb.GlobalContext, config libkbfs.Config) keybase1.SimpleFSInterface
NewSimpleFS creates a new SimpleFS instance.
Types ¶
type SimpleFS ¶
type SimpleFS struct {
// contains filtered or unexported fields
}
SimpleFS is the simple filesystem rpc layer implementation.
func (*SimpleFS) SimpleFSCancel ¶
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 ¶
SimpleFSClose - Close removes a handle associated with Open / List.
func (*SimpleFS) SimpleFSCopy ¶
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
SimpleFSDumpDebuggingInfo - Instructs KBFS to dump debugging info into its logs.
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 ¶
SimpleFSGetOps - Get all the outstanding operations
func (*SimpleFS) SimpleFSList ¶
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) SimpleFSMakeOpid ¶
SimpleFSMakeOpid - Convenience helper for generating new random value
func (*SimpleFS) SimpleFSMove ¶
SimpleFSMove - Begin move of file or directory, from/to KBFS only
func (*SimpleFS) SimpleFSOpen ¶
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) SimpleFSRemove ¶
SimpleFSRemove - Remove file or directory from filesystem
func (*SimpleFS) SimpleFSRename ¶
SimpleFSRename - Rename file or directory, KBFS side only
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, path keybase1.Path) (de keybase1.Dirent, err error)
SimpleFSStat - Get info about file
func (*SimpleFS) SimpleFSSyncStatus ¶ added in v1.0.48
SimpleFSSyncStatus - Get sync status.
func (*SimpleFS) SimpleFSWait ¶
SimpleFSWait - Blocking wait for the pending operation to finish
func (*SimpleFS) SimpleFSWrite ¶
SimpleFSWrite - Append content to opened file. May be repeated until OpID is closed.
Source Files