place

type Backend interface {
	Name() string
	CacheKeyName(pattern string) string
	List(ctx context.Context, backendName string, pattern string) (Printable, error)
}

type CommandHelp struct {
	Name  string            // Name of the command, e.g. "link"
	Short string            // Single line description
	Long  string            // Long multi-line description
	Opts  map[string]string // maps option name to a single line help
}

type Commander interface {
	// Command the backend to run a named command
	//
	// The command run is name
	// args may be used to read arguments from
	// opts may be used to read optional arguments from
	//
	// The result should be capable of being JSON encoded
	// If it is a string or a []string it will be shown to the user
	// otherwise it will be JSON encoded and shown to the user like that
	Command(ctx context.Context, name string, arg []string, opt map[string]string) (interface{}, error)
}

type ConfigInfo struct {
	NoCache        bool
	NoColor        bool
	OutFormat      string
	BackendsString string
	CacheTTL       time.Duration
}

type FlattenData struct {
	Len   int
	Bytes []byte
}

type Instance struct {
	Model `mapstructure:",squash"`
	Raw   interface{}
}

type Model struct {
	ID          string `json:"id"`
	BackendName string `json:"backend_name" mapstructure:"backend_name"`
	Name        string `json:"name"`
	Type        string `json:"type"`
	Status      string `json:"status"`
	PrivateIP   string `json:"private_ip" mapstructure:"private_ip"`
	PublicIP    string `json:"public_ip" mapstructure:"public_ip"`
}

type Option struct {
	Name       string           // name of the option in snake_case
	Help       string           // Help, the first line only is used for the command line help
	Provider   string           // Set to filter on provider
	Default    interface{}      // default value, nil => ""
	Value      interface{}      // value to be set by flags
	Examples   OptionExamples   `json:",omitempty"` // config examples
	ShortOpt   string           // the short option for this if required
	Hide       OptionVisibility // set this to hide the config from the configurator or the command line
	Required   bool             // this option is required
	IsPassword bool             // set if the option is a passwords
	NoPrefix   bool             // set if the option for this should not use the backend prefix
	Advanced   bool             // set if this is an advanced config option
}

type OptionExample struct {
	Value    string
	Help     string
	Provider string
}

type OptionExamples []OptionExample

type OptionVisibility byte

type Options []Option

type Printable []*Instance

type RegInfo struct {
	// Name of this backend
	Name string
	// Description of this fs - defaults to Name
	Description string
	// Prefix for command line flags for this fs - defaults to Name if not set
	Prefix string

	NewBackend func(ctx context.Context, config configmap.Mapper) (Backend, error) `json:"-"`
	// Function to call to help with config
	Config func(ctx context.Context, name string, config configmap.Mapper) `json:"-"`
	// Options for the Backend configuration
	Options Options
	// The command help, if any
	CommandHelp []CommandHelp
}