sftp

package
v1.16.1 Latest Latest
Warning

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

Go to latest
Published: Nov 11, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
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 NewManager(logger *zap.Logger, sshMgr *ssh.Manager, transfers *transfer.Registry, queue transfer.QueueStore) *Manager

func (*Manager) CancelTransfer

func (sft *Manager) CancelTransfer(transferID string) error

func (*Manager) Chmod

func (sft *Manager) Chmod(sessionID, path string, modeBits uint32) error

func (*Manager) Chown

func (sft *Manager) Chown(sessionID, path string, uid, gid int) error

func (*Manager) CloseAll

func (sft *Manager) CloseAll()

func (*Manager) CloseSession

func (sft *Manager) CloseSession(sessionID string)

func (*Manager) Connect

func (sft *Manager) Connect(sessionID, ownerKey string) error

Connect opens an SFTP client and binds ownerKey for transfer queue ownership.

func (*Manager) CreateDirectory

func (sft *Manager) CreateDirectory(sessionID string, path string) error

func (*Manager) CreateFile

func (sft *Manager) CreateFile(sessionID string, path string) error

func (*Manager) DeleteFile

func (sft *Manager) DeleteFile(sessionID string, path string) error

func (*Manager) DeleteFiles

func (sft *Manager) DeleteFiles(sessionID string, paths []string) error

DeleteFiles deletes multiple remote paths; returns the first error after logging others.

func (*Manager) DismissTransfer

func (sft *Manager) DismissTransfer(transferID string) error

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 (sft *Manager) DownloadDirectory(sessionID, localPath, remotePath string) error

func (*Manager) DownloadDirectoryTo added in v1.10.1

func (sft *Manager) DownloadDirectoryTo(sessionID, destDir, remotePath string) error

DownloadDirectoryTo writes remotePath into destDir (destDir is the folder itself, not its parent).

func (*Manager) DownloadFile

func (sft *Manager) DownloadFile(sessionID, localPathFile, remotePathFile string) error

func (*Manager) DownloadPaths

func (sft *Manager) DownloadPaths(sessionID, localDir string, remotePaths []string) error

DownloadPaths downloads remote files/dirs into localDir asynchronously.

func (*Manager) GetWd

func (sft *Manager) GetWd(sessionID string) (string, error)

func (*Manager) ListFiles

func (sft *Manager) ListFiles(sessionID string, path string, showHidden bool) ([]FileInfo, error)

func (*Manager) ListPendingTransfers

func (sft *Manager) ListPendingTransfers(ownerKey string) ([]transfer.ProgressData, error)

func (*Manager) RenameFile

func (sft *Manager) RenameFile(sessionID string, oldPath, newPath string) error

func (*Manager) RetryTransfer

func (sft *Manager) RetryTransfer(sessionID, transferID string) error

RetryTransfer re-queues a persisted transfer using the same ID.

func (*Manager) SetOnQueued

func (sft *Manager) SetOnQueued(fn func(sessionID string, count int))

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) Stat added in v1.9.0

func (sft *Manager) Stat(sessionID, remotePath string) (FileInfo, error)

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.

func (*Manager) UploadDirectory

func (sft *Manager) UploadDirectory(sessionID, localPath, remotePath string) error

func (*Manager) UploadFile

func (sft *Manager) UploadFile(sessionID, localPath, remotePath string) error

func (*Manager) UploadPaths

func (sft *Manager) UploadPaths(sessionID, remotePath string, localPaths []string) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址