mutagen

Documentation

Overview

Package mutagen provides infrastructure for interfacing wth Mutagen.

Index

• type Liaison
  • func (l *Liaison) ComposeService() api.Service
  • func (l *Liaison) DockerClient() client.APIClient
  • func (l *Liaison) RegisterComposeService(service api.Service)
  • func (l *Liaison) RegisterDockerCLI(cli command.Cli)
  • func (l *Liaison) RegisterDockerFlags(flags *pflag.FlagSet)

Types

type Liaison

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

Liaison is the interface point between Compose and Mutagen. Its zero value is initialized and ready to use. It implements the Compose service API. It is a single-use type, is not safe for concurrent usage, and its Shutdown method should be invoked when usage is complete.

func (*Liaison) ComposeService

func (l *Liaison) ComposeService() api.Service

ComposeService returns a Mutagen-aware version of the Compose Service API. This function must only be called after a Compose service has been registered with RegisterComposeService.

func (*Liaison) DockerClient

func (l *Liaison) DockerClient() client.APIClient

DockerClient returns a Mutagen-aware version of the Docker API client. This method must only be called after the associated Docker CLI (registered with RegisterDockerCLI) can return a valid API client via its Client method.

func (*Liaison) RegisterComposeService

func (l *Liaison) RegisterComposeService(service api.Service)

RegisterComposeService registers the underlying Compose service. The Compose service must be initialized using the Docker API client returned by the liaison's DockerClient method.

func (*Liaison) RegisterDockerCLI

func (l *Liaison) RegisterDockerCLI(cli command.Cli)

RegisterDockerCLI registers the associated Docker CLI instance.

func (*Liaison) RegisterDockerFlags

func (l *Liaison) RegisterDockerFlags(flags *pflag.FlagSet)

RegisterDockerFlags registers the associated Docker command line flags.