integration

type Attribute uint8

type ConnectorType string

type Country string

type EndpointType string

type Exporter interface {
	Origin() string
	Type() string
	Root() string
	Flags() location.Flags
	Ping(context.Context) error
	Export(context.Context, <-chan *Record, chan<- *Result) error
	Close(context.Context) error
}

type ExporterFn func(context.Context, *Options, string, map[string]string) (Exporter, error)

type FileInfo struct {
	Lname      string      `json:"name" msgpack:"name"`
	Lsize      int64       `json:"size" msgpack:"size"`
	Lmode      fs.FileMode `json:"mode" msgpack:"mode"`
	LmodTime   time.Time   `json:"mod_time" msgpack:"mod_time"`
	Ldev       uint64      `json:"dev" msgpack:"dev"`
	Lino       uint64      `json:"ino" msgpack:"ino"`
	Luid       uint64      `json:"uid" msgpack:"uid"`
	Lgid       uint64      `json:"gid" msgpack:"gid"`
	Lnlink     uint16      `json:"nlink" msgpack:"nlink"`
	Lusername  string      `json:"username" msgpack:"username"`   // local addition
	Lgroupname string      `json:"groupname" msgpack:"groupname"` // local addition

	// Just in case we need something special to handle special
	// OSes.
	Flags uint32 `json:"flags" msgpack:"flags"`
}

type HostEndpoint struct {
	Type       EndpointType
	Endpoint   string
	Attributes map[string]string
}

type Importer interface {
	Origin() string
	Type() string
	Root() string
	Flags() location.Flags
	Ping(context.Context) error
	Import(context.Context, chan<- *Record, <-chan *Result) error
	Close(context.Context) error
}

type ImporterFn func(context.Context, *Options, string, map[string]string) (Importer, error)

type Inventory interface {
	List(context.Context, chan<- *InventoryEntry) error
	Close(context.Context) error
}

type InventoryEntry struct {
	Class    ResourceClass    // interpreted
	SubClass ResourceSubClass // interpreted
	Tags     []string         // <value>, <key>=<value>

	// The rest is provider data
	URN       string //
	Name      string //
	Region    string // eu-west-3, paris/dc-1, ...
	Service   string // s3, ec2, instance, dedicated-server, ...
	Resource  string // s3:bucket, ec2:volume, ...
	Details   []byte // Additional backend-specific content
	Endpoints []HostEndpoint

	// Fill via CountryOf. Report it on every entry you can.
	Country Country
}

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

type MAC [32]byte

type Mode uint32

type Options struct {
	Hostname        string
	OperatingSystem string
	Architecture    string
	CWD             string
	MaxConcurrency  int
	Excludes        []string
	NoXattr         bool

	Stdin  io.Reader `msgpack:"-"`
	Stdout io.Writer `msgpack:"-"`
	Stderr io.Writer `msgpack:"-"`
}

type Range struct {
	Offset uint64
	Length uint32
}

type Record struct {
	// kloset doesn't make use of this field at all, it's just
	// echoed back in the record.
	ID string

	Reader io.ReadCloser

	Pathname string
	Err      error

	IsXattr   bool
	XattrName string
	XattrType Attribute

	Target             string
	FileInfo           FileInfo
	ExtendedAttributes []string
	FileAttributes     uint32
}

type ResourceClass string

type ResourceSubClass string

type Result struct {
	Record Record
	Err    error
}

type SecretProvider interface {
	Ping(ctx context.Context) error
	Resolve(ctx context.Context, handle string) (secret string, err error)
	Close(ctx context.Context) error
}

type StorageFlag uint32

type StorageResource uint32

type Store interface {
	Create(context.Context, []byte) error
	Open(context.Context) ([]byte, error)
	Ping(context.Context) error

	Origin() string
	Type() string
	Root() string
	Flags() location.Flags

	Mode(context.Context) (Mode, error)
	Size(context.Context) (int64, error) // this can be costly, call with caution
	List(context.Context, StorageResource) ([]MAC, error)
	Put(context.Context, StorageResource, MAC, io.Reader) (int64, error)
	Get(context.Context, StorageResource, MAC, *Range) (io.ReadCloser, error)
	Delete(context.Context, StorageResource, MAC) error

	Close(ctx context.Context) error
}

type StoreFn func(context.Context, string, map[string]string) (Store, error)