types

type DialCloser interface {
	io.Closer

	Dial(network, address string) (net.Conn, error)
}

type DialCloserFunc func(network, address string) (net.Conn, error)

type DialClosers []DialCloser

type DirectoryReadCloser = interface {
	fs.ReadDirFS
	io.Closer
}

type DirectoryReader = fs.FS

type FileReadCloser = io.ReadCloser

type FileReader = io.Reader

type Host interface {
	io.Closer
	Sheller
	Transmitter

	// State returns the status of the host.
	State(ctx context.Context) (HostStatus, error)
	// Execute executes the given command on the host.
	Execute(ctx context.Context, cmd string, args ...string) error
	// ExecuteWithOutput executes the given command on the host and returns the output.
	ExecuteWithOutput(ctx context.Context, cmd string, args ...string) ([]byte, error)
}

type HostAddressParsed struct {
	Scheme string
	Host   string
	Port   int
}

type HostOption struct {
	Address  string
	Authn    HostOptionAuthn
	Insecure bool
}

type HostOptionAuthn struct {
	Type   string
	User   string
	Secret string
	Agent  bool
}

type HostOptions struct {
	HostOption

	Proxies []HostOption
}

type HostStatus struct {
	Accessible bool
	OS         string
	Arch       string
	Version    string
}

type Sheller interface {
	// Shell returns a terminal to execute multiple commands on the host.
	Shell(ctx context.Context, cmdArgs ...string) (Terminal, error)
}

type Terminal interface {
	io.ReadWriteCloser

	// Execute executes the given command on the host.
	Execute(cmd string, args ...string) error
	// ExecuteWithOutput executes the given command on the host and returns the output.
	ExecuteWithOutput(cmd string, args ...string) ([]byte, error)
}

type Transmitter interface {
	// UploadFile uploads the given file to the host.
	UploadFile(ctx context.Context, from FileReader, to string) error
	// UploadDirectory uploads the given directory to the host.
	UploadDirectory(ctx context.Context, from DirectoryReader, to string) error
	// DownloadFile downloads the given file from the host.
	DownloadFile(ctx context.Context, from string) (FileReadCloser, error)
	// DownloadDirectory downloads the given directory from the host.
	DownloadDirectory(ctx context.Context, from string) (DirectoryReadCloser, error)
}