Documentation
¶
Index ¶
- Constants
- type FileInfo
- type Manager
- func (sft *Manager) CancelTransfer(transferID string) error
- func (sft *Manager) Chmod(sessionID, path string, modeBits uint32) error
- func (sft *Manager) Chown(sessionID, path string, uid, gid int) error
- func (sft *Manager) CloseAll()
- func (sft *Manager) CloseSession(sessionID string)
- func (sft *Manager) Connect(sessionID, ownerKey string) error
- func (sft *Manager) CreateDirectory(sessionID string, path string) error
- func (sft *Manager) CreateFile(sessionID string, path string) error
- func (sft *Manager) DeleteFile(sessionID string, path string) error
- func (sft *Manager) DeleteFiles(sessionID string, paths []string) error
- func (sft *Manager) DismissTransfer(transferID string) error
- func (sft *Manager) DownloadConflicts(sessionID, localDir string, remotePaths []string) ([]string, error)
- func (sft *Manager) DownloadDirectory(sessionID, localPath, remotePath string) error
- func (sft *Manager) DownloadDirectoryTo(sessionID, destDir, remotePath string) error
- func (sft *Manager) DownloadFile(sessionID, localPathFile, remotePathFile string) error
- func (sft *Manager) DownloadPaths(sessionID, localDir string, remotePaths []string) error
- func (sft *Manager) GetWd(sessionID string) (string, error)
- func (sft *Manager) ListFiles(sessionID string, path string, showHidden bool) ([]FileInfo, error)
- func (sft *Manager) ListPendingTransfers(ownerKey string) ([]transfer.ProgressData, error)
- func (sft *Manager) RenameFile(sessionID string, oldPath, newPath string) error
- func (sft *Manager) RetryTransfer(sessionID, transferID string) error
- func (sft *Manager) SetOnQueued(fn func(sessionID string, count int))
- func (sft *Manager) StartOverwriteDownload(sessionID, localFile, remoteFile string, size int64) (*transfer.Tracker, error)
- func (sft *Manager) StartOverwriteUpload(sessionID, localFile, remoteFile string, size int64) (*transfer.Tracker, error)
- func (sft *Manager) Stat(sessionID, remotePath string) (FileInfo, error)
- func (sft *Manager) UploadConflicts(sessionID, remoteDir string, localPaths []string) ([]string, error)
- func (sft *Manager) UploadDirectory(sessionID, localPath, remotePath string) error
- func (sft *Manager) UploadFile(sessionID, localPath, remotePath string) error
- func (sft *Manager) UploadPaths(sessionID, remotePath string, localPaths []string) error
Constants ¶
const (
ErrTrackerRequired = "tracker is required"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileInfo ¶
type FileInfo struct {
Name string `json:"name"`
Size int64 `json:"size"`
Mode string `json:"mode"`
ModeBits uint32 `json:"modeBits"`
UID int `json:"uid"`
GID int `json:"gid"`
ModTime string `json:"modTime"`
IsDir bool `json:"isDir"`
}
FileInfo represents file information for SFTP operations
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
func NewManager ¶
func (*Manager) CancelTransfer ¶
func (*Manager) CloseSession ¶
func (*Manager) Connect ¶
Connect opens an SFTP client and binds ownerKey for transfer queue ownership.
func (*Manager) CreateDirectory ¶
func (*Manager) DeleteFiles ¶
DeleteFiles deletes multiple remote paths; returns the first error after logging others.
func (*Manager) DismissTransfer ¶
func (*Manager) DownloadConflicts ¶ added in v1.14.0
func (sft *Manager) DownloadConflicts(sessionID, localDir string, remotePaths []string) ([]string, error)
DownloadConflicts returns basenames under localDir that already exist for the given remote paths.
func (*Manager) DownloadDirectory ¶
func (*Manager) DownloadDirectoryTo ¶ added in v1.10.1
DownloadDirectoryTo writes remotePath into destDir (destDir is the folder itself, not its parent).
func (*Manager) DownloadFile ¶
func (*Manager) DownloadPaths ¶
DownloadPaths downloads remote files/dirs into localDir asynchronously.
func (*Manager) ListPendingTransfers ¶
func (sft *Manager) ListPendingTransfers(ownerKey string) ([]transfer.ProgressData, error)
func (*Manager) RenameFile ¶
func (*Manager) RetryTransfer ¶
RetryTransfer re-queues a persisted transfer using the same ID.
func (*Manager) SetOnQueued ¶
SetOnQueued registers a callback after transfers are successfully enqueued.
func (*Manager) StartOverwriteDownload ¶ added in v1.9.0
func (sft *Manager) StartOverwriteDownload(sessionID, localFile, remoteFile string, size int64) (*transfer.Tracker, error)
StartOverwriteDownload queues a full download that truncates the local file.
func (*Manager) StartOverwriteUpload ¶ added in v1.9.0
func (sft *Manager) StartOverwriteUpload(sessionID, localFile, remoteFile string, size int64) (*transfer.Tracker, error)
StartOverwriteUpload queues a replace upload. remoteFile is the final path.
func (*Manager) UploadConflicts ¶ added in v1.14.0
func (sft *Manager) UploadConflicts(sessionID, remoteDir string, localPaths []string) ([]string, error)
UploadConflicts returns basenames under remoteDir that already exist for the given local paths.