go/pocketbase
1
0
Fork 0
mirror of https://github.com/pocketbase/pocketbase.git synced 2025-07-14 09:44:16 +02:00
Code Issues Releases Activity

added godoc comments and license notes for the gocloud.dev vendored code

Browse Source
This commit is contained in:
Gani Georgiev
2025-03-07 23:12:47 +02:00
parent 087eaa7ea4
commit f799083c4f
7 changed files with 79 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
tools/filesystem/internal/s3blob/s3/s3.go
View File

@ -1,3 +1,23 @@
// Package s3 implements a lightweight client for interacting with the
// REST APIs of any S3 compatible service.
//
// It implements only the minimal functionality required by PocketBase
// such as objects list, get, copy, delete and upload.
//
// For more details why we don't use the official aws-sdk-go-v2, you could check
// https://github.com/pocketbase/pocketbase/discussions/6562.
//
// Example:
//
// client := &s3.S3{
// Endpoint: "example.com",
// Region: "us-east-1",
// Bucket: "test",
// AccessKey: "...",
// SecretKey: "...",
// UsePathStyle: true,
// }
// resp, err := client.GetObject(context.Background(), "abc.txt")
package s3
import (
@ -27,7 +47,7 @@ type HTTPClient interface {
}
type S3 struct {
// Client specifies the HTTP client to send the request with.
// Client specifies a custom HTTP client to send the request with.
//
// If not explicitly set, fallbacks to http.DefaultClient.
Client HTTPClient