sftp

README

Package sftp

This package provides a think layer on top of the pkg/sftp package. It includes a Client type that provides a higher level abstraction for sending and receiving files over SFTP. It also provides with a sftptest package that provides a mock SFTP server for testing purposes.

Documentation

Index

• type Client
  • func NewClient(network string, addr string, config *ssh.ClientConfig) (*Client, error)
  • func (client *Client) Close() error
  • func (client *Client) Download(path string, writer io.Writer) error
  • func (client *Client) Upload(local io.Reader, path string) error

Types

type Client

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

func NewClient

func NewClient(network string, addr string, config *ssh.ClientConfig) (*Client, error)

func (*Client) Close

func (client *Client) Close() error

Close closes the connection to the remote server.

func (*Client) Download

func (client *Client) Download(path string, writer io.Writer) error

Download downloads the content of the source file on the remote server to the writer.

func (*Client) Upload

func (client *Client) Upload(local io.Reader, path string) error

Upload uploads the content of the reader to the target file on the remote server.