ulext

Documentation

Overview

Package ulext provides an interface for the CLI to interface with the external world.

Index

• func RegisterAccess(ctx context.Context, access *uplink.Access, authService string, public bool, ...) (accessKey, secretKey, endpoint string, err error)
• type External
• type Option
  • func BypassEncryption(bypass bool) Option
  • func ConnectionPoolOptions(options rpcpool.Options) Option
• type Options
  • func LoadOptions(options ...Option) (opts Options)

Functions

func RegisterAccess

func RegisterAccess(ctx context.Context, access *uplink.Access, authService string, public bool, timeout time.Duration) (accessKey, secretKey, endpoint string, err error)

RegisterAccess registers an access grant with a Gateway Authorization Service.

Types

type External

type External interface {
	OpenFilesystem(ctx context.Context, accessName string, options ...Option) (ulfs.Filesystem, error)
	OpenProject(ctx context.Context, accessName string, options ...Option) (*uplink.Project, error)

	AccessInfoFile() string
	OpenAccess(accessName string) (access *uplink.Access, err error)
	GetAccessInfo(required bool) (string, map[string]string, error)
	SaveAccessInfo(defaultName string, accesses map[string]string) error
	RequestAccess(ctx context.Context, satelliteAddress, apiKey, passphrase string, unencryptedObjectKeys bool) (*uplink.Access, error)
	ExportAccess(ctx context.Context, access *uplink.Access, filename string) error

	ConfigFile() string
	SaveConfig(values map[string]string) error

	PromptInput(ctx context.Context, prompt string) (input string, err error)
	PromptSecret(ctx context.Context, prompt string) (secret string, err error)
}

External is the interface for all of the ways that the uplink command may interact with any external state.

type Option

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

Option is a single option that controls the Options struct.

func BypassEncryption

func BypassEncryption(bypass bool) Option

BypassEncryption will disable decrypting of path names if bypass is true.

func ConnectionPoolOptions

func ConnectionPoolOptions(options rpcpool.Options) Option

ConnectionPoolOptions will initialize the connection pool with options.

type Options

type Options struct {
	EncryptionBypass      bool
	ConnectionPoolOptions rpcpool.Options
}

Options contains all of the possible options for opening a filesystem or project.

func LoadOptions

func LoadOptions(options ...Option) (opts Options)

LoadOptions takes a slice of Option values and returns a filled out Options struct.