marshal: do not encode embedded structs as sub-table (#368)
Currently, the marshalling code encodes the embedded structs as sub-tables. This is a bit unexpected, as it differs from what encoding/json does in that case: https://play.golang.org/p/KDPaGtrijV1 Unmarshalling code handles this scenario gracefully. This PR adapts the encoder to behave like encoding/json. Fields in an embedded struct are promoted to the top level table. In case the embedded struct is named in the tag, it will still encode as a sub-table. The added PromoteAnonymous option on the Encoder allows configuring the old behavior, where anonymous structs are encoded as sub-tables. On duplicate keys, the behavior of encoding/json is mimicked: Fields from anonymous structs are shadowed by regular fields. An example is added to show the affects of setting PromoteAnonymous.
This commit is contained in:
+64
@@ -5,6 +5,7 @@ package toml_test
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
|
||||
toml "github.com/pelletier/go-toml"
|
||||
)
|
||||
@@ -104,3 +105,66 @@ func ExampleUnmarshal() {
|
||||
// Output:
|
||||
// user= pelletier
|
||||
}
|
||||
|
||||
func ExampleEncoder_anonymous() {
|
||||
type Credentials struct {
|
||||
User string `toml:"user"`
|
||||
Password string `toml:"password"`
|
||||
}
|
||||
|
||||
type Protocol struct {
|
||||
Name string `toml:"name"`
|
||||
}
|
||||
|
||||
type Config struct {
|
||||
Version int `toml:"version"`
|
||||
Credentials
|
||||
Protocol `toml:"Protocol"`
|
||||
}
|
||||
config := Config{
|
||||
Version: 2,
|
||||
Credentials: Credentials{
|
||||
User: "pelletier",
|
||||
Password: "mypassword",
|
||||
},
|
||||
Protocol: Protocol{
|
||||
Name: "tcp",
|
||||
},
|
||||
}
|
||||
fmt.Println("Default:")
|
||||
fmt.Println("---------------")
|
||||
|
||||
def := toml.NewEncoder(os.Stdout)
|
||||
if err := def.Encode(config); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Println("---------------")
|
||||
fmt.Println("With promotion:")
|
||||
fmt.Println("---------------")
|
||||
|
||||
prom := toml.NewEncoder(os.Stdout).PromoteAnonymous(true)
|
||||
if err := prom.Encode(config); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
// Output:
|
||||
// Default:
|
||||
// ---------------
|
||||
// password = "mypassword"
|
||||
// user = "pelletier"
|
||||
// version = 2
|
||||
//
|
||||
// [Protocol]
|
||||
// name = "tcp"
|
||||
// ---------------
|
||||
// With promotion:
|
||||
// ---------------
|
||||
// version = 2
|
||||
//
|
||||
// [Credentials]
|
||||
// password = "mypassword"
|
||||
// user = "pelletier"
|
||||
//
|
||||
// [Protocol]
|
||||
// name = "tcp"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user