downloader

Documentation

Index

• Variables
• type Client
  • func New(client Downloader, opts ...Option) *Client
  • func (c *Client) AsyncDownloader(ctx context.Context, dir string, fileDlQueue <-chan *slack.File) (chan struct{}, error)
  • func (c *Client) DownloadFile(dir string, f slack.File) error
  • func (c *Client) SaveFile(ctx context.Context, dir string, f *slack.File) (int64, error)
  • func (c *Client) Start(ctx context.Context)
  • func (c *Client) Stop()
• type Downloader
• type FileRequest
• type Option
  • func Limiter(l *rate.Limiter) Option
  • func Retries(n int) Option
  • func Workers(n int) Option

Variables

var ErrNotStarted = errors.New("downloader not started")

Types

type Client

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

func New

func New(client Downloader, opts ...Option) *Client

Ne initialises new file downloader

func (*Client) AsyncDownloader

func (c *Client) AsyncDownloader(ctx context.Context, dir string, fileDlQueue <-chan *slack.File) (chan struct{}, error)

AsyncDownloader starts Client.worker goroutines to download files concurrently. It will download any file that is received on fileDlQueue channel. It returns the "done" channel and an error. "done" channel will be closed once all downloads are complete.

func (*Client) DownloadFile

func (c *Client) DownloadFile(dir string, f slack.File) error

DownloadFile requires a started downloader, otherwise it will return ErrNotStarted. Will place the file to the download queue, and save the file to the directory that was specified when Start was called. If the file buffer is full, will block until it becomes empty.

func (*Client) SaveFile

func (c *Client) SaveFile(ctx context.Context, dir string, f *slack.File) (int64, error)

SaveFile saves a single file to the specified directory synchrounously.

func (*Client) Start

func (c *Client) Start(ctx context.Context)

Start starts an async file downloader. If the downloader is already started, it does nothing.

func (*Client) Stop

func (c *Client) Stop()

type Downloader

type Downloader interface {
	// GetFile retreives a given file from its private download URL
	GetFile(downloadURL string, writer io.Writer) error
}

Downloader is the file downloader interface. It exists primarily for mocking in tests.

type FileRequest

type FileRequest struct {
	Directory string
	File      *slack.File
}

type Option

type Option func(*Client)

func Limiter

func Limiter(l *rate.Limiter) Option

Limiter uses the initialised limiter instead of built in.

func Retries

func Retries(n int) Option

func Workers

func Workers(n int) Option