cmd

Documentation

Index

• Variables
• func DisplayGatewayCredentials(credentials *edge.Credentials, format, awsProfile string) (err error)
• func IsSerializedAccess(access string) bool
• func RegisterAccess(ctx context.Context, access *uplink.Access, authService string, public bool, ...) (credentials *edge.Credentials, err error)
• type AccessConfig
  • func (a AccessConfig) GetAccess() (_ *uplink.Access, err error)
  • func (a AccessConfig) GetNamedAccess(name string) (_ *uplink.Access, err error)
• type ClientConfig
• type Config
• type UplinkFlags
• type WriterAt
  • func (w *WriterAt) Truncate(size int64) error
  • func (w *WriterAt) WriteAt(p []byte, off int64) (n int, err error)

Variables

var (

	// Error is the class of errors returned by this package.
	Error = errs.Class("uplink")
	// ErrAccessFlag is used where the `--access` flag is registered but not supported.
	ErrAccessFlag = Error.New("--access flag not supported with `setup` and `import` subcommands")
)

var RootCmd = &cobra.Command{
	Use:                "uplink",
	Short:              "The Storj client-side CLI",
	Args:               cobra.OnlyValidArgs,
	PersistentPreRunE:  combineCobraFuncs(startCPUProfile, modifyFlagDefaults),
	PersistentPostRunE: stopAndWriteProfile,
}

RootCmd represents the base CLI command when called without any subcommands.

Functions

func DisplayGatewayCredentials

func DisplayGatewayCredentials(credentials *edge.Credentials, format, awsProfile string) (err error)

DisplayGatewayCredentials formats and writes credentials to stdout.

func IsSerializedAccess

func IsSerializedAccess(access string) bool

IsSerializedAccess returns whether the passed access is a serialized access string or not.

func RegisterAccess

func RegisterAccess(ctx context.Context, access *uplink.Access, authService string, public bool, certificateFile string) (credentials *edge.Credentials, err error)

RegisterAccess registers an access grant with a Gateway Authorization Service.

Types

type AccessConfig

type AccessConfig struct {
	Accesses map[string]string `internal:"true"`
	Access   string            `help:"the serialized access, or name of the access to use" default:"" basic-help:"true"`

	// used for backward compatibility
	Scopes map[string]string `internal:"true"` // deprecated
	Scope  string            `internal:"true"` // deprecated
}

AccessConfig holds information about which accesses exist and are selected.

func (AccessConfig) GetAccess

func (a AccessConfig) GetAccess() (_ *uplink.Access, err error)

GetAccess returns the appropriate access for the config.

func (AccessConfig) GetNamedAccess

func (a AccessConfig) GetNamedAccess(name string) (_ *uplink.Access, err error)

GetNamedAccess returns named access if exists.

type ClientConfig

type ClientConfig struct {
	UserAgent   string        `help:"User-Agent used for connecting to the satellite" default:""`
	DialTimeout time.Duration `help:"timeout for dials" default:"0h2m00s"`
	EnableQUIC  bool          `help:"Use QUIC as the transport protocol when it's available, otherwise, fallback to TCP" default:"false"`
}

ClientConfig is a configuration struct for the uplink that controls how to talk to the rest of the network.

type Config

type Config struct {
	AccessConfig
	Client ClientConfig
}

Config uplink configuration.

type UplinkFlags

type UplinkFlags struct {
	Config

	Version checker.Config

	PBKDFConcurrency int `` /* 373-byte string literal not displayed */
}

UplinkFlags configuration flags.

type WriterAt

type WriterAt struct {
	object.WriterAt
	// contains filtered or unexported fields
}

WriterAt wraps writer and progress bar to display progress correctly.

func (*WriterAt) Truncate

func (w *WriterAt) Truncate(size int64) error

Truncate truncates writer to specific size.

func (*WriterAt) WriteAt

func (w *WriterAt) WriteAt(p []byte, off int64) (n int, err error)

WriteAt writes bytes to wrapped writer and add amount of bytes to progress bar.