activity

type Export struct {
	*File
	ID int64 `json:"id"`
}

type Exporter interface {
	// Export exports the data file
	Export(ctx context.Context, activityID int64) (*Export, error)
}

type File struct {
	io.Reader `json:"-"`
	Filename  string `json:"filename,omitempty"`
	Name      string `json:"name"`
	Format    Format `json:"format"`
}

type Format int

type GPXEncoder interface {
	// GPX returns a GPX instance
	GPX() (*gpx.GPX, error)
}

type Pagination struct {
	// Total number of resources to query
	Total int
	// Start querying at this page
	Start int
	// Count of the number of resources to query per page
	Count int
}

type Paginator interface {
	// PageSize returns the number of resources to query per request
	PageSize() int
	// Count of the aggregate total of resources queried
	Count() int
	// Do executes the query using the pagination specification returning
	// the number of resources returned in this request or an error
	Do(ctx context.Context, spec Pagination) (int, error)
}

type Poll struct {
	// Upload is the upload status if no error occurred
	Upload Upload
	// Err is non-nil when an error occurred in the operation but not semantically
	// Check the `Upload` for semantic errors (eg missing data, duplicate activity, ...)
	Err error
}

type Poller interface {
	// Poll the status of an upload
	//
	// The operation will continue until either it is completed, the context
	//  is canceled, or the maximum number of iterations have been exceeded.
	Poll(ctx context.Context, uploadID UploadID) <-chan *Poll
}

type PollerOption func(p *poller)

type Upload interface {
	// Identifier is unique id for the upload
	Identifier() UploadID
	// Done returns whether the upload is complete, either successfully or an error occurred
	Done() bool
}

type UploadID int64

type Uploader interface {
	// Upload uploads a file
	Upload(ctx context.Context, file *File) (Upload, error)
	// Status returns the processing status of a file
	Status(ctx context.Context, id UploadID) (Upload, error)
}