fileupload

type Client ¶

type Client interface {
	CreateRevisionFromChan(ctx context.Context, paths <-chan string, rootPath string) (UploadResult, error)
}

Client defines the interface for the high level file upload client.

func NewClient(httpClient *http.Client, cfg Config, opts ...Option) Client

type Config ¶

type Config struct {
	BaseURL string
	OrgID   OrgID
}

Config contains configuration for the file upload client.

type ContentTranscoder ¶ added in v0.9.0

type ContentTranscoder func(content []byte) ([]byte, error)

ContentTranscoder transforms a file's content before it is uploaded. The returned content is the one filtered by the file size limit and uploaded.

type FakeClient ¶

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

func NewFakeClient() *FakeClient

func (f *FakeClient) CreateRevisionFromChan(ctx context.Context, paths <-chan string, rootDir string) (UploadResult, error)

func (f *FakeClient) GetLastRevisionID() RevisionID

func (f *FakeClient) GetRevisionPaths(revID RevisionID) []string

func (f *FakeClient) GetUploadCount() int

func (f *FakeClient) UploadOccurred() bool

func (f *FakeClient) WithError(err error) *FakeClient

type FileAccessError ¶

type FileAccessError = uploadrevision.FileAccessError

FileAccessError indicates a file access permission issue.

type FileCountLimitError ¶

type FileCountLimitError = uploadrevision.FileCountLimitError

FileCountLimitError indicates too many files were provided.

type FilePathLengthLimitError ¶

type FilePathLengthLimitError = uploadrevision.FilePathLengthLimitError

FilePathLengthLimitError indicates a file's path exceeds the maximum allowed size.

type FileSizeLimitError ¶

type FileSizeLimitError = uploadrevision.FileSizeLimitError

FileSizeLimitError indicates a file exceeds the maximum allowed size.

type HTTPClient ¶

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

HTTPClient provides high-level file upload functionality.

func (c *HTTPClient) CreateRevisionFromChan(ctx context.Context, paths <-chan string, rootPath string) (UploadResult, error)

type HTTPError ¶

type HTTPError = uploadrevision.HTTPError

HTTPError indicates an HTTP request/response error.

type MultipartError ¶

type MultipartError = uploadrevision.MultipartError

MultipartError indicates an issue with multipart request handling.

type Option ¶

type Option func(*HTTPClient)

Option allows customizing the Client during construction.

func WithContentTranscoder(transcode ContentTranscoder) Option

func WithLogger(logger *zerolog.Logger) Option

func WithPathEncoder(encode PathEncoder) Option

func WithUploadRevisionSealableClient(client uploadrevision.SealableClient) Option

type OrgID ¶

type OrgID = uploadrevision.OrgID

OrgID represents an organization identifier.

type PathEncoder ¶ added in v0.9.0

type PathEncoder func(path string) string

PathEncoder transforms a file's upload path, relative to the root directory. The encoded path is the one filtered by the path length limit and reported for skipped files.

type RevisionID ¶

type RevisionID = uploadrevision.RevisionID

RevisionID represents a revision identifier.

type SkippedFile ¶

type SkippedFile struct {
	Path   string
	Reason error
}

SkippedFile represents a file that was skipped. It includes the skipped file's path and the reason it was skipped.

type SpecialFileError ¶

type SpecialFileError = uploadrevision.SpecialFileError

SpecialFileError indicates a path points to a special file (device, pipe, socket, etc.) instead of a regular file.

type TotalPayloadSizeLimitError ¶

type TotalPayloadSizeLimitError = uploadrevision.TotalPayloadSizeLimitError

TotalPayloadSizeLimitError indicates the total size of all files exceeds the maximum allowed payload size.

type UploadResult ¶

type UploadResult struct {
	RevisionID         RevisionID    // The ID of the revision which was created.
	UploadedFilesCount int           // The number of uploaded files.
	SkippedFiles       []SkippedFile // The list of files which were skipped.
}

UploadResult respresents the result of the upload.