s3

Documentation

Overview

Package s3 implements an s3 server for rclone

Package s3 implements a fake s3 server for rclone

Package s3 implements a fake s3 server for rclone

Index

• Variables
• type Options
• type Server
  • func (w *Server) Bind(router chi.Router)
  • func (w *Server) Serve() error

Variables

var Command = &cobra.Command{
	Annotations: map[string]string{
		"versionIntroduced": "v1.65",
		"groups":            "Filter",
		"status":            "Experimental",
	},
	Use:   "s3 remote:path",
	Short: `Serve remote:path over s3.`,
	Long:  help() + httplib.AuthHelp(flagPrefix) + httplib.Help(flagPrefix) + vfs.Help(),
	RunE: func(command *cobra.Command, args []string) error {
		var f fs.Fs
		if proxyflags.Opt.AuthProxy == "" {
			cmd.CheckArgs(1, 1, command, args)
			f = cmd.NewFsSrc(args)
		} else {
			cmd.CheckArgs(0, 0, command, args)
		}

		if Opt.hashName == "auto" {
			Opt.hashType = f.Hashes().GetOne()
		} else if Opt.hashName != "" {
			err := Opt.hashType.Set(Opt.hashName)
			if err != nil {
				return err
			}
		}
		cmd.Run(false, false, command, func() error {
			s, err := newServer(context.Background(), f, &Opt)
			if err != nil {
				return err
			}
			router := s.server.Router()
			s.Bind(router)
			err = s.Serve()
			if err != nil {
				return err
			}
			s.server.Wait()
			return nil
		})
		return nil
	},
}

Command definition for cobra

var DefaultOpt = Options{

	Auth: httplib.DefaultAuthCfg(),
	HTTP: httplib.DefaultCfg(),
	// contains filtered or unexported fields
}

DefaultOpt is the default values used for Options

var Opt = DefaultOpt

Opt is options set by command line flags

Types

type Options

type Options struct {
	Auth httplib.AuthConfig
	HTTP httplib.Config
	// contains filtered or unexported fields
}

Options contains options for the http Server

type Server

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

Server is a s3.FileSystem interface

func (*Server) Bind

func (w *Server) Bind(router chi.Router)

Bind register the handler to http.Router

func (*Server) Serve

func (w *Server) Serve() error

Serve serves the s3 server