Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sftp

package module

Go to main page

Versions in this module

v1

v1.10.0

Feb 5, 2019

Changes in this version

type Client

+ func (c *Client) Wait() error

v1.9.1

Feb 5, 2019

v1.9.0

Feb 5, 2019

v1.8.3

Sep 17, 2018

v1.8.2

Aug 22, 2018

v1.8.1

Aug 1, 2018

v1.8.0

Jun 11, 2018

Changes in this version

+ const ErrSshFxBadMessage

+ const ErrSshFxConnectionLost

+ const ErrSshFxEof

+ const ErrSshFxFailure

+ const ErrSshFxNoConnection

+ const ErrSshFxNoSuchFile

+ const ErrSshFxOk

+ const ErrSshFxOpUnsupported

+ const ErrSshFxPermissionDenied

+ const SftpServerWorkerCount

+ var ErrBadPattern = path.ErrBadPattern

+ var InternalInconsistency = errors.New("internal inconsistency")

+ var MaxFilelist int64 = 100

+ func Join(elem ...string) string

+ func Match(pattern, name string) (matched bool, err error)

+ func Split(path string) (dir, file string)

+ type Client struct

+ func NewClient(conn *ssh.Client, opts ...ClientOption) (*Client, error)

+ func NewClientPipe(rd io.Reader, wr io.WriteCloser, opts ...ClientOption) (*Client, error)

+ func (c *Client) Chmod(path string, mode os.FileMode) error

+ func (c *Client) Chown(path string, uid, gid int) error

+ func (c *Client) Chtimes(path string, atime time.Time, mtime time.Time) error

+ func (c *Client) Close() error

+ func (c *Client) Create(path string) (*File, error)

+ func (c *Client) Getwd() (string, error)

+ func (c *Client) Glob(pattern string) (matches []string, err error)

+ func (c *Client) Join(elem ...string) string

+ func (c *Client) Lstat(p string) (os.FileInfo, error)

+ func (c *Client) Mkdir(path string) error

+ func (c *Client) MkdirAll(path string) error

+ func (c *Client) Open(path string) (*File, error)

+ func (c *Client) OpenFile(path string, f int) (*File, error)

+ func (c *Client) PosixRename(oldname, newname string) error

+ func (c *Client) ReadDir(p string) ([]os.FileInfo, error)

+ func (c *Client) ReadLink(p string) (string, error)

+ func (c *Client) Remove(path string) error

+ func (c *Client) RemoveDirectory(path string) error

+ func (c *Client) Rename(oldname, newname string) error

+ func (c *Client) Stat(p string) (os.FileInfo, error)

+ func (c *Client) StatVFS(path string) (*StatVFS, error)

+ func (c *Client) Symlink(oldname, newname string) error

+ func (c *Client) Truncate(path string, size int64) error

+ func (c *Client) Walk(root string) *fs.Walker

+ type ClientOption func(*Client) error

+ func MaxConcurrentRequestsPerFile(n int) ClientOption

+ func MaxPacket(size int) ClientOption

+ func MaxPacketChecked(size int) ClientOption

+ func MaxPacketUnchecked(size int) ClientOption

+ type File struct

+ func (f *File) Chmod(mode os.FileMode) error

+ func (f *File) Chown(uid, gid int) error

+ func (f *File) Close() error

+ func (f *File) Name() string

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

+ func (f *File) ReadFrom(r io.Reader) (int64, error)

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

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

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

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

+ func (f *File) WriteTo(w io.Writer) (int64, error)

+ type FileAttrFlags struct

+ Acmodtime bool

+ Permissions bool

+ Size bool

+ UidGid bool

+ type FileCmder interface

+ Filecmd func(*Request) error

+ type FileLister interface

+ Filelist func(*Request) (ListerAt, error)

+ type FileOpenFlags struct

+ Append bool

+ Creat bool

+ Excl bool

+ Read bool

+ Trunc bool

+ Write bool

+ type FileReader interface

+ Fileread func(*Request) (io.ReaderAt, error)

+ type FileStat struct

+ Atime uint32

+ Extended []StatExtended

+ GID uint32

+ Mode uint32

+ Mtime uint32

+ Size uint64

+ UID uint32

+ func (a FileStat) FileMode() os.FileMode

+ type FileWriter interface

+ Filewrite func(*Request) (io.WriterAt, error)

+ type Handlers struct

+ FileCmd FileCmder

+ FileGet FileReader

+ FileList FileLister

+ FilePut FileWriter

+ func InMemHandler() Handlers

+ type ListerAt interface

+ ListAt func([]os.FileInfo, int64) (int, error)

+ type Request struct

+ Attrs []byte

+ Filepath string

+ Flags uint32

+ Method string

+ Target string

+ func NewRequest(method, path string) *Request

+ func (r *Request) AttrFlags() FileAttrFlags

+ func (r *Request) Attributes() *FileStat

+ func (r *Request) Context() context.Context

+ func (r *Request) Pflags() FileOpenFlags

+ func (r *Request) WithContext(ctx context.Context) *Request

+ type RequestServer struct

+ Handlers Handlers

+ func NewRequestServer(rwc io.ReadWriteCloser, h Handlers) *RequestServer

+ func (rs *RequestServer) Close() error

+ func (rs *RequestServer) Serve() error

+ type Server struct

+ func NewServer(rwc io.ReadWriteCloser, options ...ServerOption) (*Server, error)

+ func (svr *Server) Serve() error

+ type ServerOption func(*Server) error

+ func ReadOnly() ServerOption

+ func WithDebug(w io.Writer) ServerOption

+ type StatExtended struct

+ ExtData string

+ ExtType string

+ type StatVFS struct

+ Bavail uint64

+ Bfree uint64

+ Blocks uint64

+ Bsize uint64

+ Favail uint64

+ Ffree uint64

+ Files uint64

+ Flag uint64

+ Frsize uint64

+ Fsid uint64

+ ID uint32

+ Namemax uint64

+ func (p *StatVFS) FreeSpace() uint64

+ func (p *StatVFS) MarshalBinary() ([]byte, error)

+ func (p *StatVFS) TotalSpace() uint64

+ type StatusError struct

+ Code uint32

+ func (s *StatusError) Error() string