helper

Documentation

Index

• func AddDiagnosticOnError(diag *diag.Diagnostics, summary string, err error) bool
• func AsStringSlice[S ~string](in []S) []string
• func FloatToPPM(f float64) int
• func FloatToPercentString(f float64) string
• func PPMToFloat(t int) float64
• func ToPtr[T any](v T) *T
• type DetailedErrorDiagnostic
  • func NewDetailedErrorDiagnostic(summary string, e *client.DetailedError) DetailedErrorDiagnostic
  • func (d DetailedErrorDiagnostic) Detail() string
  • func (d DetailedErrorDiagnostic) Equal(other diag.Diagnostic) bool
  • func (d DetailedErrorDiagnostic) Severity() diag.Severity
  • func (d DetailedErrorDiagnostic) Summary() string

Functions

func AddDiagnosticOnError

func AddDiagnosticOnError(diag *diag.Diagnostics, summary string, err error) bool

AddDiagnosticOnError is a helper function which will take an error and a context-specific summary of the action.

If err is nil, this function will return false. If err is non-nil, this function will return ture and take one the following actions:

• if it is a client.DetailedError, a DetailedErrorDiagnostic will be added to diag.
• otherwise a generic error diagnostic will be added to diag.

func AsStringSlice

func AsStringSlice[S ~string](in []S) []string

AsStringSlice converts a slice of string-like things to a slice of strings.

func FloatToPPM

func FloatToPPM(f float64) int

FloatToPPM converts a floating point percentage to a parts per million value

func FloatToPercentString

func FloatToPercentString(f float64) string

FloatToPercentString converts a floating point percentage to a string, with a maximum of 4 decimal places, no trailing zeros

func PPMToFloat

func PPMToFloat(t int) float64

converts a parts per million value to a floating point percentage

func ToPtr

func ToPtr[T any](v T) *T

ToPtr returns a pointer to the given value

Types

type DetailedErrorDiagnostic

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

DetailedErrorDiagnostic is a Diagnostic which nicely wraps a client.DetailedError

func NewDetailedErrorDiagnostic

func NewDetailedErrorDiagnostic(summary string, e *client.DetailedError) DetailedErrorDiagnostic

NewDetailedErrorDiagnostic creates a new DetailedErrorDiagnostic taking a context-specific summary of the action and a DetailedError.

func (DetailedErrorDiagnostic) Detail

func (d DetailedErrorDiagnostic) Detail() string

func (DetailedErrorDiagnostic) Equal

func (d DetailedErrorDiagnostic) Equal(other diag.Diagnostic) bool

func (DetailedErrorDiagnostic) Severity

func (d DetailedErrorDiagnostic) Severity() diag.Severity

func (DetailedErrorDiagnostic) Summary

func (d DetailedErrorDiagnostic) Summary() string