files

Documentation

Index

• Constants
• Variables
• func GetContentLength(m *files.FileMetaData) string
• func GetFilename(m *files.FileMetaData) string
• func Moved(m *files.FileMetaData) bool
• func Unpublished(m *files.FileMetaData) bool
• func UploadIncomplete(m *files.FileMetaData) bool
• func Uploaded(m *files.FileMetaData) bool
• type ContextKey
• type FileDownloader
  • func DownloadFile(s3client content.S3Client) FileDownloader
• type HTTPClient
• type MetadataFetcher
  • func FetchMetadata(filesClient downloads.FilesClient, authToken string) MetadataFetcher

Constants

const (
	CREATED   string = "CREATED"   // first chunk uploaded
	UPLOADED  string = "UPLOADED"  // all chunks uploaded
	PUBLISHED string = "PUBLISHED" // published - authorized for public download
	MOVED     string = "MOVED"     // available from S3/CDN
)

Variables

var ErrBadJSONResponse = errors.New("could not decode JSON response from files api")

var ErrFileNotRegistered = errors.New("file not registered")

var ErrInternalServerError = errors.New("internal server error")

var ErrNotAuthorised = errors.New("the request was not authorised - check token and user's permissions")

var ErrRequest = errors.New("an error occurred making a request to files api")

var ErrUnknown = errors.New("an unknown error occurred")

Functions

func GetContentLength

func GetContentLength(m *files.FileMetaData) string

func GetFilename

func GetFilename(m *files.FileMetaData) string

func Moved

func Moved(m *files.FileMetaData) bool

func Unpublished

func Unpublished(m *files.FileMetaData) bool

func UploadIncomplete

func UploadIncomplete(m *files.FileMetaData) bool

func Uploaded

func Uploaded(m *files.FileMetaData) bool

Types

type ContextKey

type ContextKey string

type FileDownloader

type FileDownloader func(path string) (io.ReadCloser, error)

func DownloadFile

func DownloadFile(s3client content.S3Client) FileDownloader

type HTTPClient

type HTTPClient interface {
	Do(ctx context.Context, req *http.Request) (*http.Response, error)
}

type MetadataFetcher

type MetadataFetcher func(ctx context.Context, path string) (files.FileMetaData, error)

func FetchMetadata

func FetchMetadata(filesClient downloads.FilesClient, authToken string) MetadataFetcher