What does an underscore and interface name after keyword var mean?

SyntaxInterfaceGoUnderscores

Syntax Problem Overview


From http://golang.org/src/pkg/database/sql/driver/types.go:

type ValueConverter interface {
	// ConvertValue converts a value to a driver Value.
	ConvertValue(v interface{}) (Value, error)
}

var Bool boolType

type boolType struct{}

var _ ValueConverter = boolType{} // line 58

func (boolType) String() string { return "Bool" }

func (boolType) ConvertValue(src interface{}) (Value, error) {....}

I known that ValueConverter is an interface name. Line 58 seems to declare that boolType implement interface ValueConverter, but is that necessary? I deleted line 58 and the code works well.

Syntax Solutions


Solution 1 - Syntax

It provides a static (compile time) check that boolType satisfies the ValueConverter interface. The _ used as a name of the variable tells the compiler to effectively discard the RHS value, but to type-check it and evaluate it if it has any side effects, but the anonymous variable per se doesn't take any process space.

It is a handy construct when developing and the method set of an interface and/or the methods implemented by a type are frequently changed. The construct serves as a guard against forgetting to match the method sets of a type and of an interface where the intent is to have them compatible. It effectively prevents to go install a broken (intermediate) version with such omission.

Solution 2 - Syntax

It seems like you are creating a dummy value of type ValueConverter, assigning a new boolType object to it and then discarding it (which is the meaning of the underscore in go, as in for _, elt := range myRange { ...} if you are not interested in the index of the enumeration).

My guess is that it simply correspond to a static check to ensure that the struct boolType does implement the ValueConverter interface. This way, when you change the implementation of boolType, the compiler will complain early if you broke the implementation of ValueConverter interface as it will be unable to cast your new boolType to this interface.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestiondilfishView Question on Stackoverflow
Solution 1 - SyntaxzzzzView Answer on Stackoverflow
Solution 2 - SyntaxvalView Answer on Stackoverflow