sftpfs

Documentation

Index

• func New(client *sftp.Client) afero.Afero
• type File
  • func FileCreate(s *sftp.Client, name string) (*File, error)
  • func FileOpen(s *sftp.Client, name string) (*File, error)
  • func (f *File) Close() error
  • func (f *File) Name() string
  • func (f *File) Read(b []byte) (n int, err error)
  • func (f *File) ReadAt(b []byte, off int64) (n int, err error)
  • func (f *File) Readdir(count int) (res []os.FileInfo, err error)
  • func (f *File) Readdirnames(n int) (names []string, err error)
  • func (f *File) Seek(offset int64, whence int) (int64, error)
  • func (f *File) Stat() (os.FileInfo, error)
  • func (f *File) Sync() error
  • func (f *File) Truncate(size int64) error
  • func (f *File) Write(b []byte) (n int, err error)
  • func (f *File) WriteAt(b []byte, off int64) (n int, err error)
  • func (f *File) WriteString(s string) (ret int, err error)
• type Fs
  • func (s Fs) Chmod(name string, mode os.FileMode) error
  • func (s Fs) Chown(name string, uid, gid int) error
  • func (s Fs) Chtimes(name string, atime time.Time, mtime time.Time) error
  • func (s Fs) Create(name string) (afero.File, error)
  • func (s Fs) Lstat(p string) (os.FileInfo, error)
  • func (s Fs) Mkdir(name string, perm os.FileMode) error
  • func (s Fs) MkdirAll(path string, perm os.FileMode) error
  • func (s Fs) Name() string
  • func (s Fs) Open(name string) (afero.File, error)
  • func (s Fs) OpenFile(name string, flag int, perm os.FileMode) (afero.File, error)
  • func (s Fs) Remove(name string) error
  • func (s Fs) RemoveAll(path string) error
  • func (s Fs) Rename(oldname, newname string) error
  • func (s Fs) Stat(name string) (os.FileInfo, error)

Functions

func New

func New(client *sftp.Client) afero.Afero

New 创建一个新的 Fs 实例 参数：

• client: *sftp.Client SFTP 客户端

返回值：

• afero.Afero 新的 Fs 实例

Types

type File

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

File 表示一个远程文件

func FileCreate

func FileCreate(s *sftp.Client, name string) (*File, error)

FileCreate 创建远程文件 参数：

• s: *sftp.Client SFTP客户端
• name: string 文件名

返回值：

• *File 文件对象
• error 可能的错误

func FileOpen

func FileOpen(s *sftp.Client, name string) (*File, error)

FileOpen 打开远程文件 参数：

• s: *sftp.Client SFTP客户端
• name: string 文件名

返回值：

• *File 文件对象
• error 可能的错误

func (*File) Close

func (f *File) Close() error

Close 关闭文件 返回值：

• error 可能的错误

func (*File) Name

func (f *File) Name() string

Name 返回文件名 返回值：

• string 文件名

func (*File) Read

func (f *File) Read(b []byte) (n int, err error)

Read 读取文件内容 参数：

• b: []byte 读取缓冲区

返回值：

• n int 读取的字节数
• error 可能的错误

func (*File) ReadAt

func (f *File) ReadAt(b []byte, off int64) (n int, err error)

ReadAt 从指定位置读取文件内容 参数：

• b: []byte 读取缓冲区
• off: int64 读取偏移量

返回值：

• n int 读取的字节数
• error 可能的错误

func (*File) Readdir

func (f *File) Readdir(count int) (res []os.FileInfo, err error)

Readdir 读取目录内容 参数：

• count: int 读取的文件数

返回值：

• res []os.FileInfo 文件信息列表
• error 可能的错误

func (*File) Readdirnames

func (f *File) Readdirnames(n int) (names []string, err error)

Readdirnames 读取目录内容并返回文件名列表 参数：

• n: int 读取的文件数

返回值：

• names []string 文件名列表
• error 可能的错误

func (*File) Seek

func (f *File) Seek(offset int64, whence int) (int64, error)

Seek 设置文件偏移量 参数：

• offset: int64 偏移量
• whence: int 偏移方式

返回值：

• int64 新的偏移量
• error 可能的错误

func (*File) Stat

func (f *File) Stat() (os.FileInfo, error)

Stat 返回文件信息 返回值：

• os.FileInfo 文件信息
• error 可能的错误

func (*File) Sync

func (f *File) Sync() error

Sync 同步文件（SFTP不支持，返回nil）

func (*File) Truncate

func (f *File) Truncate(size int64) error

Truncate 截断文件 参数：

• size: int64 截断后的文件大小

返回值：

• error 可能的错误

func (*File) Write

func (f *File) Write(b []byte) (n int, err error)

Write 写入数据到文件 参数：

• b: []byte 要写入的数据

返回值：

• n int 写入的字节数
• error 可能的错误

func (*File) WriteAt

func (f *File) WriteAt(b []byte, off int64) (n int, err error)

WriteAt 写入数据到文件的指定位置（TODO） 参数：

• b: []byte 要写入的数据
• off: int64 写入的偏移量

返回值：

• n int 写入的字节数
• error 可能的错误

func (*File) WriteString

func (f *File) WriteString(s string) (ret int, err error)

WriteString 写入字符串到文件 参数：

• s: string 要写入的字符串

返回值：

• ret int 写入的字节数
• error 可能的错误

type Fs

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

Fs 是一个实现了 afero.Fs 接口的文件系统，使用 sftp 包提供的功能。 对于任何方法的详细信息，请参考 sftp 包的文档（github.com/pkg/sftp）。

func (Fs) Chmod

func (s Fs) Chmod(name string, mode os.FileMode) error

Chmod 修改文件权限 参数：

• name: string 文件名
• mode: os.FileMode 文件权限

返回值：

• error 可能的错误

func (Fs) Chown

func (s Fs) Chown(name string, uid, gid int) error

Chown 修改文件拥有者 参数：

• name: string 文件名
• uid: int 用户ID
• gid: int 组ID

返回值：

• error 可能的错误

func (Fs) Chtimes

func (s Fs) Chtimes(name string, atime time.Time, mtime time.Time) error

Chtimes 修改文件访问时间和修改时间 参数：

• name: string 文件名
• atime: time.Time 访问时间
• mtime: time.Time 修改时间

返回值：

• error 可能的错误

func (Fs) Create

func (s Fs) Create(name string) (afero.File, error)

Create 创建一个新文件 参数：

• name: string 文件名

返回值：

• afero.File 文件对象
• error 可能的错误

func (Fs) Lstat

func (s Fs) Lstat(p string) (os.FileInfo, error)

Lstat 返回符号链接文件信息 参数：

• p: string 路径

返回值：

• os.FileInfo 文件信息
• error 可能的错误

func (Fs) Mkdir

func (s Fs) Mkdir(name string, perm os.FileMode) error

Mkdir 创建一个新目录 参数：

• name: string 目录名
• perm: os.FileMode 目录权限

返回值：

• error 可能的错误

func (Fs) MkdirAll

func (s Fs) MkdirAll(path string, perm os.FileMode) error

MkdirAll 递归创建目录 参数：

• path: string 目录路径
• perm: os.FileMode 目录权限

返回值：

• error 可能的错误

func (Fs) Name

func (s Fs) Name() string

Name 返回文件系统的名称 返回值：

• string 文件系统名称

func (Fs) Open

func (s Fs) Open(name string) (afero.File, error)

Open 打开文件 参数：

• name: string 文件名

返回值：

• afero.File 文件对象
• error 可能的错误

func (Fs) OpenFile

func (s Fs) OpenFile(name string, flag int, perm os.FileMode) (afero.File, error)

OpenFile 调用 SSHFS 连接上的 OpenFile 方法。mode 参数被忽略 因为 github.com/pkg/sftp 实现中忽略了该参数。 参数：

• name: string 文件名
• flag: int 文件打开标志
• perm: os.FileMode 文件权限

返回值：

• afero.File 文件对象
• error 可能的错误

func (Fs) Remove

func (s Fs) Remove(name string) error

Remove 删除文件 参数：

• name: string 文件名

返回值：

• error 可能的错误

func (Fs) RemoveAll

func (s Fs) RemoveAll(path string) error

RemoveAll 递归删除路径 参数：

• path: string 路径

返回值：

• error 可能的错误

func (Fs) Rename

func (s Fs) Rename(oldname, newname string) error

Rename 重命名文件或目录 参数：

• oldname: string 旧名称
• newname: string 新名称

返回值：

• error 可能的错误

func (Fs) Stat

func (s Fs) Stat(name string) (os.FileInfo, error)

Stat 返回文件信息 参数：

• name: string 文件名

返回值：

• os.FileInfo 文件信息
• error 可能的错误