-
Notifications
You must be signed in to change notification settings - Fork 1
/
doc.go
53 lines (39 loc) · 1.58 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*
sumtype takes a list of Go package paths or files and looks for sum type
declarations in each package/file provided. Exhaustiveness checks are then
performed for each use of a declared sum type in a type switch statement.
Namely, sumtype will report an error for any type switch statement that
either lacks a default clause or does not account for all possible variants.
Declarations are provided in comments like so:
//sumtype:decl
type MySumType interface { ... }
MySumType must be *sealed*. That is, part of its interface definition contains
an unexported method.
sumtype will produce an error if any of the above is not true.
For valid declarations, sumtype will look for all occurrences in which a
value of type MySumType participates in a type switch statement. In those
occurrences, it will attempt to detect whether the type switch is exhaustive
or not. If it's not, sumtype will report an error. For example:
$ cat mysumtype.go
package gochecksumtype
//sumtype:decl
type MySumType interface {
sealed()
}
type VariantA struct{}
func (a *VariantA) sealed() {}
type VariantB struct{}
func (b *VariantB) sealed() {}
func main() {
switch MySumType(nil).(type) {
case *VariantA:
}
}
$ sumtype mysumtype.go
mysumtype.go:18:2: exhaustiveness check failed for sum type 'MySumType': missing cases for VariantB
Adding either a default clause or a clause to handle *VariantB will cause
exhaustive checks to pass.
As a special case, if the type switch statement contains a default clause
that always panics, then exhaustiveness checks are still performed.
*/
package gochecksumtype