diagnostics

Documentation

Index

• Variables
• func FindByExtra[T any](diags Diag) *hcl.Diagnostic
• func PrintDiags(output *os.File, diags Diag, fileMap map[string]*hcl.File, colorize bool)
• type Diag
  • func FromErr(err error, summary string) Diag
  • func FromErrSubj(err error, summary string, subject *hcl.Range) Diag
  • func FromHcl(diag *hcl.Diagnostic) Diag
  • func (d *Diag) Add(summary, detail string)
  • func (d *Diag) Append(diag *hcl.Diagnostic) (addedErrors bool)
  • func (d *Diag) AppendErr(err error, summary string) (haveAddedErrors bool)
  • func (d Diag) Error() string
  • func (d *Diag) Extend(diags Diag) (haveAddedErrors bool)
  • func (d *Diag) ExtendHcl(diags hcl.Diagnostics) (haveAddedErrors bool)
  • func (d *Diag) HasErrors() bool

Variables

var RepeatedError = &hcl.Diagnostic{
	Severity: hcl.DiagError,
	Extra:    repeatedError{},
}

Invisible to user error, typically used to signal that the initial block evaluation has failed (and already has reported its errors to user).

Functions

func FindByExtra

func FindByExtra[T any](diags Diag) *hcl.Diagnostic

func PrintDiags

func PrintDiags(output *os.File, diags Diag, fileMap map[string]*hcl.File, colorize bool)

Types

type Diag

type Diag hcl.Diagnostics // Diagnostics does implement error interface, but not, itself, an error.

func FromErr

func FromErr(err error, summary string) Diag

func FromErrSubj

func FromErrSubj(err error, summary string, subject *hcl.Range) Diag

func FromHcl

func FromHcl(diag *hcl.Diagnostic) Diag

func (*Diag) Add

func (d *Diag) Add(summary, detail string)

Add new diagnostic error.

func (*Diag) Append

func (d *Diag) Append(diag *hcl.Diagnostic) (addedErrors bool)

Appends diag to diagnostics, returns true if the just-appended diagnostic is an error.

func (*Diag) AppendErr

func (d *Diag) AppendErr(err error, summary string) (haveAddedErrors bool)

Creates diagnostic and appends it if err != nil.

func (Diag) Error

func (d Diag) Error() string

func (*Diag) Extend

func (d *Diag) Extend(diags Diag) (haveAddedErrors bool)

Appends all diags to diagnostics, returns true if the just-appended diagnostics contain an error.

func (*Diag) ExtendHcl

func (d *Diag) ExtendHcl(diags hcl.Diagnostics) (haveAddedErrors bool)

Appends all diags to diagnostics, returns true if the just-appended diagnostics contain an error.

func (*Diag) HasErrors

func (d *Diag) HasErrors() bool

HasErrors returns true if the receiver contains any diagnostics of severity DiagError.