s3compat

package

v0.1.0 Latest Latest Go to latest Published: Jun 3, 2026 License: GPL-3.0 Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/charlesng35/shellcn

Links

Open Source Insights

Documentation ¶

Overview ¶

Package s3compat adapts S3-compatible object storage to ShellCN's shared file browser contract.

Index ¶

func Actions(protocol string) []plugin.Action
func AdminRoutes(protocol string) []plugin.Route
func AuthFields(protocol string) []plugin.Field
func BucketTab(protocol string) plugin.Panel
func Connect(_ context.Context, cfg plugin.ConnectConfig, opts Options) (plugin.Session, error)
type Client
type Options
type Session

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Actions ¶

func Actions(protocol string) []plugin.Action

func AdminRoutes ¶

func AdminRoutes(protocol string) []plugin.Route

func AuthFields ¶

func AuthFields(protocol string) []plugin.Field

func BucketTab ¶

func BucketTab(protocol string) plugin.Panel

BucketTab is the bucket-administration tab: a table of buckets with create, delete, and versioning affordances. It coexists with the file browser tab so the object browser stays scoped to the connection's bucket while admins manage the account's buckets here.

func Connect ¶

func Connect(_ context.Context, cfg plugin.ConnectConfig, opts Options) (plugin.Session, error)

Types ¶

type Client ¶

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

func (*Client) Home ¶

func (c *Client) Home(context.Context) (string, error)

func (*Client) MapError ¶

func (c *Client) MapError(err error) error

func (*Client) Mkdir ¶

func (c *Client) Mkdir(ctx context.Context, p string) error

func (*Client) Open ¶

func (c *Client) Open(ctx context.Context, p string) (io.ReadCloser, error)

func (*Client) OpenRange ¶

func (c *Client) OpenRange(ctx context.Context, p string, offset, length int64) (io.ReadCloser, error)

func (*Client) ReadDir ¶

func (c *Client) ReadDir(ctx context.Context, p string) ([]os.FileInfo, error)

func (*Client) Remove ¶

func (c *Client) Remove(ctx context.Context, p string, isDir bool) error

func (*Client) Rename ¶

func (c *Client) Rename(ctx context.Context, from, to string) error

func (*Client) Stat ¶

func (c *Client) Stat(ctx context.Context, p string) (os.FileInfo, error)

func (*Client) Write ¶

func (c *Client) Write(ctx context.Context, p string, r io.Reader) error

type Options ¶

type Options struct {
	Endpoint      string
	Region        string
	Bucket        string
	Prefix        string
	AccessKeyID   string
	SecretKey     string
	SessionToken  string
	UsePathStyle  bool
	VerifyTLS     bool
	RequireBucket bool
}

type Session ¶

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

func (*Session) Close ¶

func (s *Session) Close() error

func (*Session) Filesystem ¶

func (s *Session) Filesystem() (filesystem.Client, error)

func (*Session) HealthCheck ¶

func (s *Session) HealthCheck(ctx context.Context) error

func (*Session) OpenChannel ¶

func (s *Session) OpenChannel(context.Context, plugin.ChannelRequest) (plugin.Channel, error)

Source Files ¶

View all Source files

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