s3

Documentation

Index

• Constants
• type Config
• type FileInfo
• type PublicLinkResponse
• type S3
  • func NewS3(ctx context.Context, cfg Config) (*S3, error)
  • func (s *S3) Delete(ctx context.Context, fileId string) error
  • func (s *S3) Download(ctx context.Context, fileId, path string) (*os.File, error)
  • func (s *S3) DownloadAsBase64(ctx context.Context, fileId string) (string, error)
  • func (s *S3) FileInfo(ctx context.Context, fileId string) (FileInfo, error)
  • func (s *S3) GetFileExt(nameWithExt string) string
  • func (s *S3) PublicLink(ctx context.Context, fileId string, publicLinkExpiration time.Duration) (PublicLinkResponse, error)
  • func (s *S3) SanitizeFileName(nameWithoutExt string) string
  • func (s *S3) Upload(ctx context.Context, file io.ReadSeeker, name, ext string) (FileInfo, error)
  • func (s *S3) UploadFromBase64(ctx context.Context, base64String, name, ext string) (FileInfo, error)

Constants

const DefaultPublicLinkExpiration = 30 * time.Minute

Types

type Config

type Config struct {
	Region          string
	Bucket          string
	AccessKeyId     string
	SecretAccessKey string
}

type FileInfo

type FileInfo struct {
	FileID       string `json:"file_id"`
	FileExt      string `json:"file_ext"`
	FileMimetype string `json:"file_mimetype"`
	FileSize     int    `json:"file_size"`
	ETag         string `json:"etag"`
	Timestamp    string `json:"timestamp"`
}

type PublicLinkResponse

type PublicLinkResponse struct {
	Url       string `json:"url"`
	ExpiredAt string `json:"expired_at"`
}

type S3

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

func NewS3

func NewS3(ctx context.Context, cfg Config) (*S3, error)

func (*S3) Delete

func (s *S3) Delete(ctx context.Context, fileId string) error

func (*S3) Download

func (s *S3) Download(ctx context.Context, fileId, path string) (*os.File, error)

func (*S3) DownloadAsBase64

func (s *S3) DownloadAsBase64(ctx context.Context, fileId string) (string, error)

func (*S3) FileInfo

func (s *S3) FileInfo(ctx context.Context, fileId string) (FileInfo, error)

func (*S3) GetFileExt

func (s *S3) GetFileExt(nameWithExt string) string

func (*S3) PublicLink

func (s *S3) PublicLink(
	ctx context.Context,
	fileId string,
	publicLinkExpiration time.Duration,
) (PublicLinkResponse, error)

func (*S3) SanitizeFileName

func (s *S3) SanitizeFileName(nameWithoutExt string) string

func (*S3) Upload

func (s *S3) Upload(ctx context.Context, file io.ReadSeeker, name, ext string) (FileInfo, error)

func (*S3) UploadFromBase64

func (s *S3) UploadFromBase64(ctx context.Context, base64String, name, ext string) (FileInfo, error)