aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/BurntSushi/toml/README.md
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-01-28 16:10:14 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2024-01-28 16:10:14 -0500
commitb06eba3df09a8fcd777b8fe350c2b184758963d1 (patch)
tree0a2ad3aa9537c0457688b7325a3858c1b328bea2 /vendor/github.com/BurntSushi/toml/README.md
parentAdd version cmd to docs (diff)
downloadcli-b06eba3df09a8fcd777b8fe350c2b184758963d1.zip
Use checkmate for tests
Diffstat (limited to 'vendor/github.com/BurntSushi/toml/README.md')
-rw-r--r--vendor/github.com/BurntSushi/toml/README.md120
1 files changed, 0 insertions, 120 deletions
diff --git a/vendor/github.com/BurntSushi/toml/README.md b/vendor/github.com/BurntSushi/toml/README.md
deleted file mode 100644
index 3651cfa..0000000
--- a/vendor/github.com/BurntSushi/toml/README.md
+++ /dev/null
@@ -1,120 +0,0 @@
-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.13 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.