role

Documentation

Index

• type Driver
  • func (role Driver) LongName() string
  • func (Driver) Name() string
  • func (Driver) RunsWithTimer() bool
• type Navigator
  • func (role Navigator) LongName() string
  • func (Navigator) Name() string
  • func (Navigator) RunsWithTimer() bool
• type Role

Types

type Driver

type Driver struct {
}

Driver is a role where the user is actively adding changes to the project

func (Driver) LongName

func (role Driver) LongName() string

LongName returns the long name for the driver role, e.g. "Driver role"

func (Driver) Name

func (Driver) Name() string

Name returns the name of the driver role

func (Driver) RunsWithTimer

func (Driver) RunsWithTimer() bool

RunsWithTimer indicates whether this role uses a timer

type Navigator

type Navigator struct {
}

Navigator is a role where the user does not apply any change, but regularly retrieves updates from git

func (Navigator) LongName

func (role Navigator) LongName() string

LongName returns the long name for the navigator role, e.g. "Navigator role"

func (Navigator) Name

func (Navigator) Name() string

Name returns the name of the navigator role

func (Navigator) RunsWithTimer

func (Navigator) RunsWithTimer() bool

RunsWithTimer indicates whether this role uses a timer

type Role

type Role interface {
	Name() string
	LongName() string
	RunsWithTimer() bool
}

Role provides the interface that a role must implement in order to be used by TCR engine