types

Documentation

Index

• Constants
• func CheckValidPerformanceMode(performanceMode string, configType ConfigType) error
• func FlagPerformanceModeDescription(configType ConfigType) string
• func FlagPerformanceModeResetDescription(configType ConfigType) string
• func IsValidPerformanceMode(performanceMode string, configType ConfigType) bool
• type ConfigType
• type PerformanceMode
  • func GetPerformanceModeDefault() PerformanceMode
  • func ValidPerformanceModeOptions(configType ConfigType) []PerformanceMode

Constants

const FlagPerformanceModeDefault = PerformanceModeEmpty

const FlagPerformanceModeName = "performance-mode"

Flag definitions

const FlagPerformanceModeResetName = "performance-mode-reset"

Functions

func CheckValidPerformanceMode

func CheckValidPerformanceMode(performanceMode string, configType ConfigType) error

CheckValidPerformance checks to see if the given performance mode option is valid and returns an error in case the value is not valid.

func FlagPerformanceModeDescription

func FlagPerformanceModeDescription(configType ConfigType) string

func FlagPerformanceModeResetDescription

func FlagPerformanceModeResetDescription(configType ConfigType) string

func IsValidPerformanceMode

func IsValidPerformanceMode(performanceMode string, configType ConfigType) bool

IsValidPerformanceMode checks to see if the given performance mode option is valid.

Types

type ConfigType

type ConfigType int

const (
	ConfigTypeGlobal ConfigType = iota
	ConfigTypeProject
)

type PerformanceMode

type PerformanceMode = string

const (
	PerformanceModeEmpty   PerformanceMode = ""
	PerformanceModeGlobal  PerformanceMode = "global"
	PerformanceModeNone    PerformanceMode = "none"
	PerformanceModeMutagen PerformanceMode = "mutagen"
	PerformanceModeNFS     PerformanceMode = "nfs"
)

func GetPerformanceModeDefault

func GetPerformanceModeDefault() PerformanceMode

GetPerformanceModeDefault returns the default performance mode config depending on the OS.

func ValidPerformanceModeOptions

func ValidPerformanceModeOptions(configType ConfigType) []PerformanceMode

ValidPerformanceModeOptions returns a slice of valid performance mode options for the project config or global config if global is true.