Documentation
¶
Index ¶
- Constants
- func CheckValidPerformanceMode(performanceMode string, configType ConfigType) error
- func CheckValidXHProfMode(xhprofMode string, configType ConfigType) error
- func FlagPerformanceModeDescription(configType ConfigType) string
- func FlagPerformanceModeResetDescription(configType ConfigType) string
- func FlagXHProfModeDescription(configType ConfigType) string
- func FlagXHProfModeResetDescription(configType ConfigType) string
- func IsValidPerformanceMode(performanceMode string, configType ConfigType) bool
- func IsValidXHProfMode(XHProfMode string, configType ConfigType) bool
- type ConfigType
- type PerformanceMode
- type XHProfMode
Constants ¶
const FlagPerformanceModeDefault = PerformanceModeEmpty
const FlagPerformanceModeName = "performance-mode"
Flag definitions
const FlagPerformanceModeResetName = "performance-mode-reset"
const FlagXHProfModeDefault = XHProfModePrepend
TODO: Default should change to XHProfModeXHGUI in DDEV v1.25.0
const FlagXHProfModeName = "xhprof-mode"
Flag definitions
const FlagXHProfModeResetName = "xhprof-mode-reset"
Variables ¶
This section is empty.
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 CheckValidXHProfMode ¶ added in v1.24.4
func CheckValidXHProfMode(xhprofMode string, configType ConfigType) error
CheckValidXHProfMode checks to see if the given xhprof 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 FlagXHProfModeDescription ¶ added in v1.24.4
func FlagXHProfModeDescription(configType ConfigType) string
func FlagXHProfModeResetDescription ¶ added in v1.24.4
func FlagXHProfModeResetDescription(configType ConfigType) string
func IsValidPerformanceMode ¶
func IsValidPerformanceMode(performanceMode string, configType ConfigType) bool
IsValidPerformanceMode checks to see if the given performance mode option is valid.
func IsValidXHProfMode ¶ added in v1.24.4
func IsValidXHProfMode(XHProfMode string, configType ConfigType) bool
IsValidXHProfMode checks to see if the given xhprof 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.
type XHProfMode ¶ added in v1.24.4
type XHProfMode = string
const ( XHProfModeEmpty XHProfMode = "" XHProfModePrepend XHProfMode = "prepend" XHProfModeXHGui XHProfMode = "xhgui" XHProfModeGlobal XHProfMode = "global" )
func ValidXHProfModeOptions ¶ added in v1.24.4
func ValidXHProfModeOptions(configType ConfigType) []XHProfMode
ValidXHProfModeOptions returns a slice of valid xhprof mode options for the project config or global config if global is true.
Source Files