Interface RichCheckEffect

assertion/function/assertiontree/rich_check_effect.go:42–63

A RichCheckEffect is the fact that a certain check is associated with an effect that can be triggered by a conditional, for example the `ok` in `v, ok := m[k]` the functions `effectIfTrue` and `effectIfFalse` are analogous to the respective returns from `AddNilCheck` - functions that are marked as

// the effect. Whether an expression invalidates this effect is determined by the interface function
// `isInvalidatedBy`.
type RichCheckEffect interface {
	// isTriggeredBy indicates whether a given expression in a conditional is sufficient to trigger
	// this `RichCheckEffect`
	isTriggeredBy(expr ast.Expr) bool

	// isInvalidatedBy indicates whether a given expression invalidates this effect
	isInvalidatedBy(node ast.Node) bool

	// effectIfTrue is the effect to insert as preprocessing in the true branch of a triggering conditional
	effectIfTrue(node *RootAssertionNode)

	// effectIfFalse is the effect to insert as preprocessing in the false branch of a triggering condition
	effectIfFalse(node *RootAssertionNode)

	// isNoop returns whether this effect is a noop (i.e. placeholder value)
	isNoop() bool

	// equals returns true iff this effect should be considered equal to another
	// correctness of these `equals` functions is vital to correctness (and termination) of the propagation
	// in `propagateRichChecks`.
	equals(RichCheckEffect) bool
}

// A FuncErrRet is a RichCheckEffect for the `err` in `r0, r1, r2, ..., err := f()`, where the
// function `f` has a final result of type `error` - and until this is checked all other results are