webdav/sync/go/pkg/mod/github.com/!burnt!sushi/toml@v1.4.1-0.20240526193622-a339e1f7089c - 志元云盘

File OriginalPic	EditTime	Size
_example	2024-08-14 12:03:57	3.34 KB
cmd	2024-08-14 12:41:03	7.38 KB
internal	2024-08-14 12:40:55	131.25 KB
ossfuzz	2024-08-14 12:41:56	665 B
testdata	2024-08-14 12:42:14	6.55 KB
bench_test.go	2024-08-14 10:33:58	4.28 KB
COPYING	2024-08-14 10:33:58	1.05 KB
decode.go	2024-08-14 10:33:58	16.66 KB
decode_test.go	2024-08-14 10:33:58	27.19 KB
deprecated.go	2024-08-14 10:33:58	821 B
doc.go	2024-08-14 10:33:58	344 B
encode.go	2024-08-14 10:33:58	18.83 KB
encode_test.go	2024-08-14 10:33:58	29.71 KB
error.go	2024-08-14 10:33:58	10.04 KB
error_test.go	2024-08-14 10:33:58	11.32 KB
example_test.go	2024-08-14 10:33:58	7.64 KB
fuzz_test.go	2024-08-14 10:33:58	1.81 KB
go.mod	2024-08-14 10:33:58	43 B
lex.go	2024-08-14 10:33:58	30.41 KB
meta.go	2024-08-14 10:33:58	3.88 KB
parse.go	2024-08-14 10:33:58	21.9 KB
README.md	2024-08-14 10:33:58	2.67 KB
toml_test.go	2024-08-14 10:33:58	12.63 KB
type_fields.go	2024-08-14 10:33:58	6.32 KB
type_toml.go	2024-08-14 10:33:58	1.88 KB

TOML stands for Tom's Obvious, Minimal Language. This Go package provides a
reflection interface similar to Go's standard library `json` and `xml` packages.

Compatible with TOML version [v1.0.0](https://toml.io/en/v1.0.0).

Documentation: https://godocs.io/github.com/BurntSushi/toml

See the [releases page](https://github.com/BurntSushi/toml/releases) for a
changelog; this information is also in the git tag annotations (e.g. `git show
v0.4.0`).

This library requires Go 1.18 or newer; add it to your go.mod with:

% go get github.com/BurntSushi/toml@latest

It also comes with a TOML validator CLI tool:

% go install github.com/BurntSushi/toml/cmd/tomlv@latest
    % tomlv some-toml-file.toml

### Examples
For the simplest example, consider some TOML file as just a list of keys and
values:

```toml
Age = 25
Cats = [ "Cauchy", "Plato" ]
Pi = 3.14
Perfection = [ 6, 28, 496, 8128 ]
DOB = 1987-07-05T05:45:00Z
```

Which can be decoded with:

```go
type Config struct {
	Age        int
	Cats       []string
	Pi         float64
	Perfection []int
	DOB        time.Time
}

var conf Config
_, err := toml.Decode(tomlData, &conf)
```

You can also use struct tags if your struct field name doesn't map to a TOML key
value directly:

```toml
some_key_NAME = "wat"
```

```go
type TOML struct {
    ObscureKey string `toml:"some_key_NAME"`
}
```

Beware that like other decoders **only exported fields** are considered when
encoding and decoding; private fields are silently ignored.

### Using the `Marshaler` and `encoding.TextUnmarshaler` interfaces
Here's an example that automatically parses values in a `mail.Address`:

```toml
contacts = [
    "Donald Duck <donald@duckburg.com>",
    "Scrooge McDuck <scrooge@duckburg.com>",
]
```

Can be decoded with:

```go
// Create address type which satisfies the encoding.TextUnmarshaler interface.
type address struct {
	*mail.Address
}

func (a *address) UnmarshalText(text []byte) error {
	var err error
	a.Address, err = mail.ParseAddress(string(text))
	return err
}

// Decode it.
func decode() {
	blob := `
		contacts = [
			"Donald Duck <donald@duckburg.com>",
			"Scrooge McDuck <scrooge@duckburg.com>",
		]
	`

var contacts struct {
		Contacts []address
	}

_, err := toml.Decode(blob, &contacts)
	if err != nil {
		log.Fatal(err)
	}

for _, c := range contacts.Contacts {
		fmt.Printf("%#v\n", c.Address)
	}

// Output:
	// &mail.Address{Name:"Donald Duck", Address:"donald@duckburg.com"}
	// &mail.Address{Name:"Scrooge McDuck", Address:"scrooge@duckburg.com"}
}
```

To target TOML specifically you can implement `UnmarshalTOML` TOML interface in
a similar way.

### More complex usage
See the [`_example/`](/_example) directory for a more complex example.

云盘

Home / 志元云盘 / webdav / sync / go / pkg / mod / github.com / !burnt!sushi / [email protected]