toml

package

v2.679.0 Latest Latest Go to latest Published: Jul 16, 2026 License: MIT Imports: 4 Imported by: 0

Details

Package toml provides TOML encoding helpers and adapters used by go-service.

This package integrates TOML encoding/decoding behind the go-service encoding abstraction.

Start with the package-level constructors.

This section is empty.

This section is empty.

func Marshal(v any) ([]byte, error)

Marshal encodes v as TOML.

func Unmarshal(data []byte, v any) error

Unmarshal decodes TOML data into v.

type Encoder struct{}

Encoder implements TOML encoding and decoding.

It uses BurntSushi/toml and rejects undecoded keys.

func NewEncoder() *Encoder

NewEncoder constructs a TOML encoder.

func (e *Encoder) Decode(r io.Reader, v any) error

Decode reads TOML from r and decodes it into v.

In most cases v should be a pointer to the destination value (for example *MyStruct).

This method rejects keys that do not decode into v.

func (e *Encoder) Encode(w io.Writer, v any) error

Encode writes v to w as TOML.

This is a thin wrapper around `toml.NewEncoder(w).Encode(v)`.