gouploader

package module

Go to main page

Versions in this module

v1

v1.7.0

May 12, 2026

Changes in this version

type ObjectStat

+ CacheControl string

+ ContentDisposition string

+ StorageClass string

+ VersionID string

+ type ObjectStorageWithResult interface

+ SaveObjectWithResult func(ctx context.Context, req SaveObjectRequest) (*SaveObjectResult, error)

type SaveObjectResult

+ ETag string

+ Metadata map[string]string

+ StorageClass string

+ VersionID string

v1.6.0

May 11, 2026

Changes in this version

type ObjectService

+ func (s *ObjectService) SignedURL(ctx context.Context, req SignedURLRequest) (string, error)

+ type SignedURLRequest struct

+ Key string

+ Scope ObjectScope

+ TTL time.Duration

v1.5.0

May 9, 2026

Changes in this version

+ const CodeObjectCopyUnsupported

+ const CodeObjectStatUnsupported

+ const LifecycleCompleteSuccess

+ const LifecyclePartComplete

+ const LifecyclePartSign

+ var ErrBucketNotFound = types.NewErr(31002, http.StatusNotFound, "云存储 bucket 不存在")

+ var ErrNetwork = types.NewErr(31008, http.StatusBadGateway, "云存储网络错误")

+ var ErrObjectCopyUnsupported = types.ErrObjectCopyUnsupported

+ var ErrObjectNotFound = types.NewErr(31004, http.StatusNotFound, "云存储对象不存在")

+ var ErrObjectStatUnsupported = types.ErrObjectStatUnsupported

+ var ErrPermissionDenied = types.NewErr(31003, http.StatusForbidden, "云存储权限不足")

+ var ErrProviderAuthFailed = types.NewErr(31001, http.StatusUnauthorized, "云存储认证失败")

+ var ErrProviderServer = types.NewErr(31009, http.StatusBadGateway, "云存储服务端错误")

+ var ErrProviderUnknown = types.NewErr(31011, http.StatusBadGateway, "云存储未知错误")

+ var ErrRateLimited = types.NewErr(31006, http.StatusTooManyRequests, "云存储请求被限流")

+ var ErrSignatureExpired = types.NewErr(31005, http.StatusUnauthorized, "云存储签名已过期")

+ var ErrTimeout = types.NewErr(31007, http.StatusGatewayTimeout, "云存储请求超时")

+ var ErrUnsupportedOperation = types.NewErr(31010, http.StatusNotImplemented, "云存储不支持该操作")

+ func BuildObjectURL(cfg ObjectURLConfig, key string) (string, error)

+ func ContextWithUploadInfo(ctx context.Context, info UploadInfo) context.Context

+ func MaskSecret(secret string) string

+ type ACL string

+ const ACLAuthenticatedRead

+ const ACLDefault

+ const ACLPrivate

+ const ACLPublicRead

+ const ACLPublicReadWrite

+ type AbortUploadRequest struct

+ Keys []string

+ Scope ObjectScope

+ type AddressingStyle string

+ const AddressingStyleAuto

+ const AddressingStylePath

+ const AddressingStyleVirtualHost

+ type BackoffPolicy func(attempt int) time.Duration

+ func ExponentialBackoff(base, maxDelay time.Duration) BackoffPolicy

+ func FixedBackoff(delay time.Duration) BackoffPolicy

+ type Capabilities struct

+ CopyObject bool

+ DeleteObjects bool

+ Multipart bool

+ RawClient bool

+ SaveObject bool

+ SignedURL bool

+ StatObject bool

+ func DetectCapabilities(storage Storage) Capabilities

+ func (c Capabilities) Require(required Capabilities) error

+ type CompleteUploadRequest struct

+ FinalKey string

+ Metadata ObjectMetadata

+ Scope ObjectScope

+ TempKey string

+ type CopyObjectRequest struct

+ DestinationKey string

+ Metadata ObjectMetadata

+ Scope ObjectScope

+ SourceKey string

+ type Credential struct

+ AccessKeyID string

+ ExpiresAt time.Time

+ SecretAccessKey string

+ SessionToken string

+ type CredentialResolver interface

+ ResolveCredential func(ctx context.Context, scope CredentialScope) (Credential, error)

+ type CredentialResolverFunc func(context.Context, CredentialScope) (Credential, error)

+ func (fn CredentialResolverFunc) ResolveCredential(ctx context.Context, scope CredentialScope) (Credential, error)

+ type CredentialScope struct

+ Bucket string

+ BucketID string

+ BusinessID string

+ Endpoint string

+ Provider string

+ Region string

+ Values map[string]string

+ type DeleteObjectRequest struct

+ Key string

+ Scope ObjectScope

+ type DeleteObjectsRequest struct

+ Keys []string

+ Scope ObjectScope

+ type ErrorKind string

+ const ErrorKindAuthFailed

+ const ErrorKindBucketNotFound

+ const ErrorKindInvalidArgument

+ const ErrorKindNetwork

+ const ErrorKindObjectNotFound

+ const ErrorKindPermissionDenied

+ const ErrorKindRateLimited

+ const ErrorKindServer

+ const ErrorKindSignatureExpired

+ const ErrorKindTimeout

+ const ErrorKindUnknown

+ const ErrorKindUnsupported

+ func (k ErrorKind) Retryable() bool

+ type MoveObjectRequest struct

+ DestinationKey string

+ Metadata ObjectMetadata

+ Scope ObjectScope

+ SourceKey string

+ type ObjectBatchDeleter interface

+ DeleteObjects func(ctx context.Context, keys []string) error

+ type ObjectCopier interface

+ CopyObject func(ctx context.Context, req CopyObjectRequest) (*ObjectStat, error)

+ type ObjectEvent struct

+ DestinationKey string

+ Key string

+ Operation ObjectOperation

+ Scope ObjectScope

+ SourceKey string

+ Stat *ObjectStat

+ type ObjectMetadata struct

+ CacheControl string

+ ContentDisposition string

+ ContentType string

+ UserMetadata map[string]string

+ type ObjectOperation string

+ const ObjectOperationCopy

+ const ObjectOperationDelete

+ const ObjectOperationMove

+ const ObjectOperationSave

+ type ObjectScope struct

+ AccessDomain string

+ Bucket string

+ Endpoint string

+ Provider string

+ Region string

+ Values map[string]string

+ type ObjectService struct

+ func NewObjectService(opts ...ObjectServiceOption) (*ObjectService, error)

+ func (s *ObjectService) CopyObject(ctx context.Context, req CopyObjectRequest) (*ObjectStat, error)

+ func (s *ObjectService) DeleteObject(ctx context.Context, req DeleteObjectRequest) error

+ func (s *ObjectService) DeleteObjects(ctx context.Context, req DeleteObjectsRequest) error

+ func (s *ObjectService) MoveObject(ctx context.Context, req MoveObjectRequest) (*ObjectStat, error)

+ func (s *ObjectService) OpenObject(ctx context.Context, req OpenObjectRequest) (io.ReadCloser, error)

+ func (s *ObjectService) PublicURL(key string) string

+ func (s *ObjectService) SaveObject(ctx context.Context, req SaveObjectRequest) (*SaveObjectResult, error)

+ func (s *ObjectService) StatObject(ctx context.Context, req StatObjectRequest) (*ObjectStat, error)

+ type ObjectServiceOption func(*objectServiceConfig)

+ func WithObjectObserver(observer func(context.Context, ObjectEvent)) ObjectServiceOption

+ func WithObjectPublicURLBuilder(builder func(key string) string) ObjectServiceOption

+ func WithObjectStorage(storage Storage) ObjectServiceOption

+ func WithObjectStorageResolver(resolver StorageResolver) ObjectServiceOption

+ type ObjectStat struct

+ ContentType string

+ ETag string

+ Key string

+ LastModified time.Time

+ Metadata map[string]string

+ Size int64

+ type ObjectStatter interface

+ StatObject func(ctx context.Context, key string) (*ObjectStat, error)

+ type ObjectStorage interface

+ SaveObject func(ctx context.Context, req SaveObjectRequest) error

+ type ObjectURLConfig struct

+ AddressingStyle AddressingStyle

+ Bucket string

+ CDNHost string

+ Endpoint string

+ Scheme string

+ type OpenObjectRequest struct

+ Key string

+ Scope ObjectScope

+ type Operation string

+ const OperationAbortMultipart

+ const OperationCompleteMultipart

+ const OperationCopyObject

+ const OperationDeleteObject

+ const OperationDeleteObjects

+ const OperationInitMultipart

+ const OperationListOrphans

+ const OperationListParts

+ const OperationMoveObject

+ const OperationOpenObject

+ const OperationPresignPart

+ const OperationSaveObject

+ const OperationStatObject

+ func (op Operation) Idempotent() bool

type Option

+ func WithCredentialResolver(resolver CredentialResolver) Option

+ func WithOnUploadLifecycle(fn func(ctx context.Context, ev *UploadLifecycleEvent)) Option

+ func WithSTSProviderResolver(resolver STSProviderResolver) Option

+ func WithStorageResolver(resolver StorageResolver) Option

+ type ProviderError struct

+ Code string

+ Err error

+ Kind ErrorKind

+ Operation string

+ Provider string

+ RequestID string

+ StatusCode int

+ func NewProviderError(info ProviderErrorInfo) *ProviderError

+ func (e *ProviderError) Error() string

+ func (e *ProviderError) Is(target error) bool

+ func (e *ProviderError) Unwrap() error

+ type ProviderErrorInfo struct

+ Code string

+ Err error

+ Kind ErrorKind

+ Operation string

+ Provider string

+ RequestID string

+ StatusCode int

+ type RetryPolicy struct

+ Backoff BackoffPolicy

+ MaxAttempts int

+ func (p RetryPolicy) Do(ctx context.Context, operation Operation, fn func() error) error

+ type STSProviderResolver interface

+ ResolveSTSProvider func(ctx context.Context) (STSProvider, error)

+ type STSProviderResolverFunc func(context.Context) (STSProvider, error)

+ func (fn STSProviderResolverFunc) ResolveSTSProvider(ctx context.Context) (STSProvider, error)

+ type SaveObjectRequest struct

+ Body io.Reader

+ Key string

+ Metadata ObjectMetadata

+ Scope ObjectScope

+ Size int64

+ type SaveObjectResult struct

+ ContentType string

+ Key string

+ Size int64

+ URL string

+ type SaveTempRequest struct

+ Body io.Reader

+ Key string

+ Metadata ObjectMetadata

+ Scope ObjectScope

+ Size int64

+ type StatObjectRequest struct

+ Key string

+ Scope ObjectScope

+ type StorageResolver interface

+ ResolveStorage func(ctx context.Context, scope ObjectScope) (Storage, error)

+ type StorageResolverFunc func(context.Context, ObjectScope) (Storage, error)

+ func (fn StorageResolverFunc) ResolveStorage(ctx context.Context, scope ObjectScope) (Storage, error)

+ type UploadInfo struct

+ Bucket string

+ BucketID string

+ BusinessID string

+ Labels map[string]string

+ Provider string

+ TaskID string

+ TempFileID string

+ UserID string

+ func UploadInfoFromContext(ctx context.Context) (UploadInfo, bool)

+ type UploadLifecycleEvent = types.UploadLifecycleEvent

+ type UploadWorkflow struct

+ func NewUploadWorkflow(objects *ObjectService) *UploadWorkflow

+ func (w *UploadWorkflow) AbortUpload(ctx context.Context, req AbortUploadRequest) error

+ func (w *UploadWorkflow) CompleteUpload(ctx context.Context, req CompleteUploadRequest) (*ObjectStat, error)

+ func (w *UploadWorkflow) SaveTemp(ctx context.Context, req SaveTempRequest) (*SaveObjectResult, error)

type Uploader

+ func (u *Uploader) ChunkService() *service.ChunkUploadService

+ func (u *Uploader) DirectService() *service.DirectUploadService

+ func (u *Uploader) Storage() Storage

+ func (u *Uploader) UploadService() *service.UploadService

v1.4.0

Apr 30, 2026

Changes in this version

type Option

+ func WithKeyPrefixSigner(secret []byte) Option

+ func WithRequireUserID() Option

+ func WithStrictPartsVerify(strict bool) Option

type S3Config

+ CDNHost string

+ type SignedURLStorage = types.SignedURLStorage

+ type UserScopedHashStore = types.UserScopedHashStore

v1.3.0

Apr 30, 2026

Changes in this version

type Option

+ func WithHashStoreRegisterTimeout(d time.Duration) Option

+ func WithPublicURLBuilder(fn func(storageKey string) string) Option

v1.2.0

Apr 24, 2026

Changes in this version

+ const AbortReasonClientRequest

+ const CodeMultipartAbortFail

+ const CodeMultipartCompleteFail

+ const CodeMultipartInitFailed

+ const CodeMultipartNotSupported

+ const CodeMultipartPresignFail

+ const CodePartETagMismatch

+ const CodePartVerifyFail

+ const CodeUnauthorized

+ const StageAbort

+ const StageComplete

+ const StageInit

+ const StageMerge

+ const StagePart

+ var ErrMultipartAbortFail = types.ErrMultipartAbortFail

+ var ErrMultipartCompleteFail = types.ErrMultipartCompleteFail

+ var ErrMultipartInitFailed = types.ErrMultipartInitFailed

+ var ErrMultipartNotSupported = types.ErrMultipartNotSupported

+ var ErrMultipartPresignFail = types.ErrMultipartPresignFail

+ var ErrPartETagMismatch = types.ErrPartETagMismatch

+ var ErrPartVerifyFail = types.ErrPartVerifyFail

+ var ErrUnauthorized = types.ErrUnauthorized

+ type ChunkCompleteRequest = types.ChunkCompleteRequest

+ type CompleteResult = types.CompleteResult

+ type HashStore = types.HashStore

+ type HashedFile = types.HashedFile

+ type InstantHitEvent = types.InstantHitEvent

+ type MultipartMeta = types.MultipartMeta

+ type MultipartStorage = types.MultipartStorage

type Option

+ func WithHashStore(hs HashStore) Option

+ func WithMultipartDisabled() Option

+ func WithMultipartFeatureFlag(fn func(ctx context.Context, ginCtx *gin.Context, req *ChunkInitRequest) bool) Option

+ func WithMultipartKeyPrefix(fn func(c *gin.Context, userID string) string) Option

+ func WithMultipartThreshold(bytes int64) Option

+ func WithOnInstantHit(fn func(ctx context.Context, ev *InstantHitEvent)) Option

+ func WithOnUploadAbort(fn func(ctx context.Context, ev *UploadAbortEvent)) Option

+ func WithOnUploadError(fn func(ctx context.Context, ev *UploadErrorEvent)) Option

+ func WithOnUploadInit(fn func(ctx context.Context, ev *UploadInitEvent)) Option

+ func WithOrphanCleanup(ttl, interval time.Duration) Option

+ func WithPartSignTTL(ttl time.Duration) Option

+ func WithUserIDFn(fn func(c *gin.Context) string) Option

+ type OrphanMultipart = types.OrphanMultipart

+ type PartETag = types.PartETag

+ type PartInfo = types.PartInfo

+ type PartSignRequest = types.PartSignRequest

+ type PartSignResponse = types.PartSignResponse

+ type PresignPartRequest = types.PresignPartRequest

+ type ResumeRequest = types.ResumeRequest

+ type ResumeResponse = types.ResumeResponse

+ type UploadAbortEvent = types.UploadAbortEvent

+ type UploadErrorEvent = types.UploadErrorEvent

+ type UploadInitEvent = types.UploadInitEvent

type Uploader

+ func (u *Uploader) HandleChunkComplete() gin.HandlerFunc

+ func (u *Uploader) HandleChunkReportPartETag() gin.HandlerFunc

+ func (u *Uploader) HandleChunkResume() gin.HandlerFunc

+ func (u *Uploader) HandleChunkSignParts() gin.HandlerFunc

v1.0.0

Apr 9, 2026

Changes in this version

+ const CodeCallbackVerifyFail

+ const CodeChecksumMismatch

+ const CodeChunkDuplicate

+ const CodeChunkHashMismatch

+ const CodeChunkIndexOutRange

+ const CodeDirectFileNotFound

+ const CodeFileReadError

+ const CodeFileTooLarge

+ const CodeFileTypeNotAllow

+ const CodeInvalidParam

+ const CodeMergeHashFailed

+ const CodeMergeIncomplete

+ const CodeMultipartError

+ const CodeSTSIssueFailed

+ const CodeSTSNotConfigured

+ const CodeSessionExpired

+ const CodeSessionNotFound

+ const CodeStorageDeleteFail

+ const CodeStorageReadFail

+ const CodeStorageWriteFail

+ const Version

+ var ErrCallbackVerifyFail = types.ErrCallbackVerifyFail

+ var ErrChecksumMismatch = types.ErrChecksumMismatch

+ var ErrChunkHashMismatch = types.ErrChunkHashMismatch

+ var ErrChunkIndexOutRange = types.ErrChunkIndexOutRange

+ var ErrDirectFileNotFound = types.ErrDirectFileNotFound

+ var ErrFileTooLarge = types.ErrFileTooLarge

+ var ErrFileTypeNotAllow = types.ErrFileTypeNotAllow

+ var ErrInvalidParam = types.ErrInvalidParam

+ var ErrMergeHashFailed = types.ErrMergeHashFailed

+ var ErrMergeIncomplete = types.ErrMergeIncomplete

+ var ErrMultipartError = types.ErrMultipartError

+ var ErrSTSIssueFailed = types.ErrSTSIssueFailed

+ var ErrSTSNotConfigured = types.ErrSTSNotConfigured

+ var ErrSessionExpired = types.ErrSessionExpired

+ var ErrSessionNotFound = types.ErrSessionNotFound

+ var ErrStorageDelete = types.ErrStorageDelete

+ var ErrStorageRead = types.ErrStorageRead

+ var ErrStorageWrite = types.ErrStorageWrite

+ func CORS(cfg CORSConfig) gin.HandlerFunc

+ type AWSSTSConfig = sts.AWSConfig

+ type AliyunSTSConfig = sts.AliyunConfig

+ type CORSConfig struct

+ AllowCredentials bool

+ AllowHeaders []string

+ AllowOrigins []string

+ ExposeHeaders []string

+ MaxAge int

+ type ChunkInitRequest = types.ChunkInitRequest

+ type ChunkInitResponse = types.ChunkInitResponse

+ type ChunkStatusResponse = types.ChunkStatusResponse

+ type ChunkUploadResponse = types.ChunkUploadResponse

+ type DirectCompleteRequest = types.DirectCompleteRequest

+ type DirectTokenRequest = types.DirectTokenRequest

+ type DirectTokenResponse = types.DirectTokenResponse

+ type DirectUploadResult = types.DirectUploadResult

+ type Error = types.Error

+ type HuaweiSTSConfig = sts.HuaweiConfig

+ type Option func(*config)

+ func WithAWSSTS(cfg AWSSTSConfig) Option

+ func WithAliyunSTS(cfg AliyunSTSConfig) Option

+ func WithAllowedTypes(types ...string) Option

+ func WithChunkCleanupInterval(interval time.Duration) Option

+ func WithChunkSessionTTL(ttl time.Duration) Option

+ func WithChunkSize(defaultSize, minSize, maxSize int64) Option

+ func WithChunkTempDir(dir string) Option

+ func WithHashAlgorithm(algo string) Option

+ func WithHuaweiSTS(cfg HuaweiSTSConfig) Option

+ func WithLocalStorage(basePath string) Option

+ func WithMaxFileSize(size int64) Option

+ func WithOnDirectUploadComplete(fn func(result *DirectUploadResult)) Option

+ func WithOnUploadComplete(fn func(result *UploadResult)) Option

+ func WithS3Storage(s3 S3Config) Option

+ func WithSTSKeyPrefix(fn func(c *gin.Context) string) Option

+ func WithSTSProvider(p STSProvider) Option

+ func WithStorage(s Storage) Option

+ func WithTencentSTS(cfg TencentSTSConfig) Option

+ type S3Config struct

+ AccessKey string

+ Bucket string

+ Endpoint string

+ Region string

+ SecretKey string

+ UseSSL bool

+ type STSCredential = types.STSCredential

+ type STSProvider = types.STSProvider

+ type Storage = types.Storage

+ type TencentSTSConfig = sts.TencentConfig

+ type UploadResult = types.UploadResult

+ type Uploader struct

+ func New(opts ...Option) (*Uploader, error)

+ func (u *Uploader) Close()

+ func (u *Uploader) HandleChunkAbort() gin.HandlerFunc

+ func (u *Uploader) HandleChunkInit() gin.HandlerFunc

+ func (u *Uploader) HandleChunkMerge() gin.HandlerFunc

+ func (u *Uploader) HandleChunkStatus() gin.HandlerFunc

+ func (u *Uploader) HandleChunkUpload() gin.HandlerFunc

+ func (u *Uploader) HandleDirectCallback() gin.HandlerFunc

+ func (u *Uploader) HandleDirectComplete() gin.HandlerFunc

+ func (u *Uploader) HandleDirectToken() gin.HandlerFunc

+ func (u *Uploader) HandleUpload() gin.HandlerFunc

+ func (u *Uploader) RegisterRoutes(group *gin.RouterGroup)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL