toml

package

v2.367.0 Latest Latest Go to latest Published: May 4, 2026 License: MIT Imports: 2 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.

This section is empty.

type Encoder struct{}

Encoder implements TOML encoding and decoding.

It uses BurntSushi/toml with default settings.

func NewEncoder() *Encoder

NewEncoder constructs a TOML encoder.

This encoder is a thin adapter around github.com/BurntSushi/toml that satisfies `github.com/alexfalkowski/go-service/v2/encoding.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 intentionally discards metadata returned by BurntSushi/toml and returns only the decode/unmarshal error (if any).

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)`.