toml

Documentation

Overview

Package toml converts TOML to and from CUE.

WARNING: THIS PACKAGE IS EXPERIMENTAL. ITS API MAY CHANGE AT ANY TIME.

Index

• type Decoder
  • func NewDecoder(filename string, r io.Reader) *Decoder
  • func (d *Decoder) Decode() (ast.Expr, error)
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(val cue.Value) error

Types

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

Decoder implements the decoding state.

Note that TOML files and streams never decode multiple CUE nodes; subsequent calls to Decoder.Decode may return io.EOF.

func NewDecoder

func NewDecoder(filename string, r io.Reader) *Decoder

NewDecoder creates a decoder from a stream of TOML input.

func (*Decoder) Decode

func (d *Decoder) Decode() (ast.Expr, error)

Decode parses the input stream as TOML and converts it to a CUE *ast.File. Because TOML files only contain a single top-level expression, subsequent calls to this method may return io.EOF.

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

Encoder implements the encoding state.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder creates an encoder to stream encoded TOML bytes.

func (*Encoder) Encode

func (e *Encoder) Encode(val cue.Value) error