space

Documentation

Index

• type Client
  • func Connect(cfg config.Space) (*Client, error)
  • func (client *Client) DownloadFile(ctx context.Context, path string) (io.ReadCloser, error)
  • func (client *Client) MaxSize() int64
  • func (client *Client) RemoveFile(name string) error
  • func (client *Client) URLFromPath(path string) string
  • func (client *Client) UploadFile(ctx context.Context, name string, mimeType string, reader io.Reader, ...) error

Types

type Client

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

func Connect

func Connect(cfg config.Space) (*Client, error)

Connect connects to a S3 space.

func (*Client) DownloadFile

func (client *Client) DownloadFile(ctx context.Context, path string) (io.ReadCloser, error)

DownloadFile opens a file for download, using the same path format as the UploadFile function. Remember to Close it! The returned stream also has `ReaderAt` and `Seeker`, but those are impl. details.

func (*Client) MaxSize

func (client *Client) MaxSize() int64

func (*Client) RemoveFile

func (client *Client) RemoveFile(name string) error

RemoveFile removes a file from the space

func (*Client) URLFromPath

func (client *Client) URLFromPath(path string) string

URLFromPath gets the URL from the path returned by UploadFile

func (*Client) UploadFile

func (client *Client) UploadFile(ctx context.Context, name string, mimeType string, reader io.Reader, size int64) error

UploadFile uploads the file to the space. This does not do any checks on it, so the endpoints should ensure that's all okay.