ulext

Documentation

Overview

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

Index

• type External
• type Option
  • func BypassEncryption(bypass bool) Option
• type Options
  • func LoadOptions(options ...Option) (opts Options)

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, token, passphrase string) (*uplink.Access, error)

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

	PromptInput(ctx clingy.Context, prompt string) (input string, err error)
	PromptSecret(ctx clingy.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.

type Options

type Options struct {
	EncryptionBypass bool
}

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.