sync

Documentation

Index

• type ArchiveBuilder
  • func NewArchiveBuilder(writer io.Writer) *ArchiveBuilder
  • func (a *ArchiveBuilder) ArchivePathsIfExist(paths []PathMapping) error
  • func (a *ArchiveBuilder) Close() error
• type ComposeClient
• type DockerCopy
  • func NewDockerCopy(projectName string, client ComposeClient, infoWriter io.Writer) *DockerCopy
  • func (d *DockerCopy) Sync(ctx context.Context, service types.ServiceConfig, paths []PathMapping) error
• type LowLevelClient
• type PathMapping
• type Syncer
• type Tar
  • func NewTar(projectName string, client LowLevelClient) *Tar
  • func (t *Tar) Sync(ctx context.Context, service types.ServiceConfig, paths []PathMapping) error

Types

type ArchiveBuilder

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

func NewArchiveBuilder

func NewArchiveBuilder(writer io.Writer) *ArchiveBuilder

func (*ArchiveBuilder) ArchivePathsIfExist

func (a *ArchiveBuilder) ArchivePathsIfExist(paths []PathMapping) error

ArchivePathsIfExist creates a tar archive of all local files in `paths`. It quietly skips any paths that don't exist.

func (*ArchiveBuilder) Close

func (a *ArchiveBuilder) Close() error

type ComposeClient

type ComposeClient interface {
	Exec(ctx context.Context, projectName string, options api.RunOptions) (int, error)

	Copy(ctx context.Context, projectName string, options api.CopyOptions) error
}

type DockerCopy

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

func NewDockerCopy

func NewDockerCopy(projectName string, client ComposeClient, infoWriter io.Writer) *DockerCopy

func (*DockerCopy) Sync

func (d *DockerCopy) Sync(ctx context.Context, service types.ServiceConfig, paths []PathMapping) error

type LowLevelClient

type LowLevelClient interface {
	ContainersForService(ctx context.Context, projectName string, serviceName string) ([]moby.Container, error)

	Exec(ctx context.Context, containerID string, cmd []string, in io.Reader) error
	Untar(ctx context.Context, id string, reader io.ReadCloser) error
}

type PathMapping

type PathMapping struct {
	// HostPath that was created/modified/deleted outside the container.
	//
	// This is the path as seen from the user's perspective, e.g.
	// 	- C:\Users\moby\Documents\hello-world\main.go (file on Windows)
	//  - /Users/moby/Documents/hello-world (directory on macOS)
	HostPath string
	// ContainerPath for the target file inside the container (only populated
	// for sync events, not rebuild).
	//
	// This is the path as used in Docker CLI commands, e.g.
	//	- /workdir/main.go
	//  - /workdir/subdir
	ContainerPath string
}

PathMapping contains the Compose service and modified host system path.

type Syncer

type Syncer interface {
	Sync(ctx context.Context, service types.ServiceConfig, paths []PathMapping) error
}

type Tar

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

func NewTar

func NewTar(projectName string, client LowLevelClient) *Tar

func (*Tar) Sync

func (t *Tar) Sync(ctx context.Context, service types.ServiceConfig, paths []PathMapping) error