package pkg import ( "encoding/json" "encoding/xml" "time" ) type T1 struct { A int B func() `json:"-" xml:"-"` c chan int } type T2 struct { T1 } type T3 struct { Ch chan int } type T4 struct { C ValueMarshaler } type T5 struct { B func() `xml:"-"` } type T6 struct { B func() `json:"-"` } type T7 struct { A int B int T3 } type T8 struct { C int *T7 } type T9 struct { F PointerMarshaler } type T10 struct { F *struct { PointerMarshaler } } type Recursive struct { Field *Recursive } type ValueMarshaler chan int func (ValueMarshaler) MarshalText() ([]byte, error) { return nil, nil } type PointerMarshaler chan int func (*PointerMarshaler) MarshalText() ([]byte, error) { return nil, nil } func fn() { var t1 T1 var t2 T2 var t3 T3 var t4 T4 var t5 T5 var t6 T6 var t8 T8 var t9 T9 var t10 T10 var t11 Recursive json.Marshal(t1) json.Marshal(t2) json.Marshal(t3) //@ diag(`unsupported type chan int, via x.Ch`) json.Marshal(t4) json.Marshal(t5) //@ diag(`unsupported type func(), via x.B`) json.Marshal(t6) (*json.Encoder)(nil).Encode(t1) (*json.Encoder)(nil).Encode(t2) (*json.Encoder)(nil).Encode(t3) //@ diag(`unsupported type chan int, via x.Ch`) (*json.Encoder)(nil).Encode(t4) (*json.Encoder)(nil).Encode(t5) //@ diag(`unsupported type func(), via x.B`) (*json.Encoder)(nil).Encode(t6) xml.Marshal(t1) xml.Marshal(t2) xml.Marshal(t3) //@ diag(`unsupported type chan int, via x.Ch`) xml.Marshal(t4) xml.Marshal(t5) xml.Marshal(t6) //@ diag(`unsupported type func(), via x.B`) (*xml.Encoder)(nil).Encode(t1) (*xml.Encoder)(nil).Encode(t2) (*xml.Encoder)(nil).Encode(t3) //@ diag(`unsupported type chan int, via x.C`) (*xml.Encoder)(nil).Encode(t4) (*xml.Encoder)(nil).Encode(t5) (*xml.Encoder)(nil).Encode(t6) //@ diag(`unsupported type func(), via x.B`) json.Marshal(t8) //@ diag(`unsupported type chan int, via x.T7.T3.Ch`) json.Marshal(t9) //@ diag(`unsupported type PointerMarshaler, via x.F`) json.Marshal(&t9) // this is fine, t9 is addressable, therefore T9.D is, too json.Marshal(t10) // this is fine, T10.F.D is addressable xml.Marshal(t8) //@ diag(`unsupported type chan int, via x.T7.T3.Ch`) xml.Marshal(t9) //@ diag(`unsupported type PointerMarshaler, via x.F`) xml.Marshal(&t9) // this is fine, t9 is addressable, therefore T9.D is, too xml.Marshal(t10) // this is fine, T10.F.D is addressable json.Marshal(t11) xml.Marshal(t11) } func addressabilityJSON() { var a PointerMarshaler var b []PointerMarshaler var c struct { F PointerMarshaler } var d [4]PointerMarshaler json.Marshal(a) //@ diag(re`unsupported type PointerMarshaler$`) json.Marshal(&a) json.Marshal(b) json.Marshal(&b) json.Marshal(c) //@ diag(`unsupported type PointerMarshaler, via x.F`) json.Marshal(&c) json.Marshal(d) //@ diag(`unsupported type PointerMarshaler, via x[0]`) json.Marshal(&d) var m1 map[string]PointerMarshaler json.Marshal(m1) //@ diag(`unsupported type PointerMarshaler, via x[k]`) json.Marshal(&m1) //@ diag(`unsupported type PointerMarshaler, via x[k]`) json.Marshal([]map[string]PointerMarshaler{m1}) //@ diag(`unsupported type PointerMarshaler, via x[0][k]`) var m2 map[string]*PointerMarshaler json.Marshal(m2) json.Marshal(&m2) json.Marshal([]map[string]*PointerMarshaler{m2}) } func addressabilityXML() { var a PointerMarshaler var b []PointerMarshaler var c struct { XMLName xml.Name `json:"foo"` F PointerMarshaler } var d [4]PointerMarshaler xml.Marshal(a) //@ diag(re`unsupported type PointerMarshaler$`) xml.Marshal(&a) xml.Marshal(b) xml.Marshal(&b) xml.Marshal(c) //@ diag(`unsupported type PointerMarshaler, via x.F`) xml.Marshal(&c) xml.Marshal(d) //@ diag(`unsupported type PointerMarshaler, via x[0]`) xml.Marshal(&d) } func mapsJSON() { var good map[int]string var bad map[interface{}]string // the map key has to be statically known good; it must be a number or a string json.Marshal(good) json.Marshal(bad) //@ diag(`unsupported type map[interface{}]string`) var m1 map[string]PointerMarshaler json.Marshal(m1) //@ diag(`unsupported type PointerMarshaler, via x[k]`) json.Marshal(&m1) //@ diag(`unsupported type PointerMarshaler, via x[k]`) json.Marshal([]map[string]PointerMarshaler{m1}) //@ diag(`unsupported type PointerMarshaler, via x[0][k]`) var m2 map[string]*PointerMarshaler json.Marshal(m2) json.Marshal(&m2) json.Marshal([]map[string]*PointerMarshaler{m2}) var m3 map[string]ValueMarshaler json.Marshal(m3) json.Marshal(&m3) json.Marshal([]map[string]ValueMarshaler{m3}) var m4 map[string]*ValueMarshaler json.Marshal(m4) json.Marshal(&m4) json.Marshal([]map[string]*ValueMarshaler{m4}) var m5 map[ValueMarshaler]string var m6 map[*ValueMarshaler]string var m7 map[PointerMarshaler]string var m8 map[*PointerMarshaler]string json.Marshal(m5) json.Marshal(m6) json.Marshal(m7) //@ diag(`unsupported type map[PointerMarshaler]string`) json.Marshal(m8) } func mapsXML() { // encoding/xml doesn't support any maps var bad map[string]string xml.Marshal(bad) //@ diag(`unsupported type`) } func fieldPriorityJSON() { // In this example, the channel doesn't matter, because T1.F has higher priority than T1.T2.F type lT2 struct { F chan int } type lT1 struct { F int lT2 } json.Marshal(lT1{}) // In this example, it does matter type lT4 struct { C chan int } type lT3 struct { F int lT4 } json.Marshal(lT3{}) //@ diag(`unsupported type chan int, via x.lT4.C`) } func fieldPriorityXML() { // In this example, the channel doesn't matter, because T1.F has higher priority than T1.T2.F type lT2 struct { F chan int } type lT1 struct { F int lT2 } xml.Marshal(lT1{}) // In this example, it does matter type lT4 struct { C chan int } type lT3 struct { F int lT4 } xml.Marshal(lT3{}) //@ diag(`unsupported type chan int, via x.lT4.C`) } func longPathJSON() { var foo struct { Field struct { Field2 []struct { Map map[string]chan int } } } json.Marshal(foo) //@ diag(`unsupported type chan int, via x.Field.Field2[0].Map[k]`) } func otherPackageJSON() { var x time.Ticker json.Marshal(x) //@ diag(`unsupported type <-chan time.Time, via x.C`) } func longPathXML() { var foo struct { Field struct { Field2 []struct { Map map[string]chan int } } } xml.Marshal(foo) //@ diag(`unsupported type map[string]chan int, via x.Field.Field2[0].Map`) } func otherPackageXML() { var x time.Ticker xml.Marshal(x) //@ diag(`unsupported type <-chan time.Time, via x.C`) } type ToplevelPointerMarshalerXML struct { Field map[string]string } func (*ToplevelPointerMarshalerXML) MarshalXML(*xml.Encoder, xml.StartElement) error { return nil } type ToplevelPointerMarshalerText struct { Field map[string]string } func (*ToplevelPointerMarshalerText) MarshalText() ([]byte, error) { return nil, nil } func toplevelPointer() { xml.Marshal(&ToplevelPointerMarshalerXML{}) xml.Marshal(&ToplevelPointerMarshalerText{}) xml.Marshal(ToplevelPointerMarshalerXML{}) //@ diag(`unsupported type`) xml.Marshal(ToplevelPointerMarshalerText{}) //@ diag(`unsupported type`) } func cyclicPointer() { type P *P type S2 struct { Bar P } type S1 struct { Foo S2 } var s S1 xml.Marshal(s) //@ diag(`cyclic type P, via x.Foo.Bar`) } func functionAsArgument(arg T1) { // https://staticcheck.io/issues/1660 json.Marshal(functionAsArgument) //@ diag(`unsupported type func(arg T1)`) xml.Marshal(functionAsArgument) //@ diag(`unsupported type func(arg T1)`) }