Per theĀ overlapping interfaces proposal, Go 1.14 now permits embedding of interfaces with overlapping method sets. This is a brief post explain what this change means:
Let’s start with the definition of the three key interfaces from the io
package; io.Reader
, io.Writer
, and io.Closer
:
package io
type Reader interface {
Read([]byte) (int, error)
}
type Writer interface {
Write([]byte) (int, error)
}
type Closer interface {
Close() error
}
Just as embedding a type inside a struct allows the embedded type’s fields andĀ methods to be accessed as if it were declared on the embedding type1, the process is true for interfaces. Thus there is no difference between explicitly declaring
type ReadCloser interface {
Read([]byte) (int, error)
Close() error
}
and using embedding to compose the interface
type ReadCloser interface {
Reader
Closer
}
You can even mix and match
type WriteCloser interface {
Write([]byte) (int, error)
Closer
}
However, prior to Go 1.14, if you continued to compose interface declarations in this manner you would likely find that something like this,
type ReadWriteCloser interface {
ReadCloser
WriterCloser
}
would fail to compile
% go build interfaces.go command-line-arguments ./interfaces.go:27:2: duplicate method Close
Fortunately, with Go 1.14 this is no longer a limitation, thus solving problems that typically occur with diamond-shaped embedding graphs.
However, there is a catch that I ran into attempting to demonstrate this feature to the local user group–this feature is only enabled when the Go compiler uses the 1.14 (or later) spec.
As near as I can make out the rules for which version of the Go spec is used during compilation appear to be:
- If your source code is stored inside
GOPATH
(or you have disabled modules withGO111MODULE=off
) then the version of the Go spec used to compile with matches the version of the compiler you are using. Said another way, if you have Go 1.13 installed, your Go version is 1.13. If you have Go 1.14 installed, your version is 1.14. No surprises here. - If your source code is stored outside
GOPATH
(or you have forced modules on withGO111MODULE=on
) then thego
tool will take the Go version from thego.mod
file. - If there is no Go version listed in
go.mod
then the version of the spec will be the version of Go installed. This is identical to point 1. - If you are in module mode, either by being outside
GOPATH
or withGO111MODULE=on
, but there is nogo.mod
file in the current, or any parent, directory then the version of the Go spec used to compile your code defaults to Go 1.13.
The last point caught me out.