encoding

Documentation

Index

• func Detect(v cue.Value) (i build.Interpretation)
• type Config
• type Decoder
  • func NewDecoder(f *build.File, cfg *Config) *Decoder
  • func (i *Decoder) Close()
  • func (i *Decoder) Done() bool
  • func (i *Decoder) Err() error
  • func (i *Decoder) File() *ast.File
  • func (i *Decoder) Filename() string
  • func (i *Decoder) ID() string
  • func (i *Decoder) Index() int
  • func (i *Decoder) Interpretation() build.Interpretation
  • func (i *Decoder) Next()
• type Encoder
  • func NewEncoder(f *build.File, cfg *Config) (*Encoder, error)
  • func (e Encoder) Close() error
  • func (e *Encoder) Encode(v cue.Value) error
  • func (e *Encoder) EncodeFile(f *ast.File) error
  • func (e *Encoder) EncodeInstance(v *cue.Instance) error
  • func (e *Encoder) IsConcrete() bool

Functions

func Detect

func Detect(v cue.Value) (i build.Interpretation)

Detect detects the interpretation.

Types

type Config

type Config struct {
	Mode filetypes.Mode

	// Out specifies an overwrite destination.
	Out    io.Writer
	Stdin  io.Reader
	Stdout io.Writer

	PkgName string // package name for files to generate

	Force     bool // overwrite existing files
	Strict    bool
	Stream    bool // potentially write more than one document per file
	AllErrors bool

	Schema cue.Value // used for schema-based decoding

	EscapeHTML    bool
	InlineImports bool // expand references to non-core imports
	ProtoPath     []string
	Format        []format.Option
	ParseFile     func(name string, src interface{}) (*ast.File, error)
}

type Decoder

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

func NewDecoder

func NewDecoder(f *build.File, cfg *Config) *Decoder

NewDecoder returns a stream of non-rooted data expressions. The encoding type of f must be a data type, but does not have to be an encoding that can stream. stdin is used in case the file is "-".

func (*Decoder) Close

func (i *Decoder) Close()

func (*Decoder) Done

func (i *Decoder) Done() bool

func (*Decoder) Err

func (i *Decoder) Err() error

func (*Decoder) File

func (i *Decoder) File() *ast.File

func (*Decoder) Filename

func (i *Decoder) Filename() string

func (*Decoder) ID

func (i *Decoder) ID() string

ID returns a canonical identifier for the decoded object or "" if no such identifier could be found.

func (*Decoder) Index

func (i *Decoder) Index() int

func (*Decoder) Interpretation

func (i *Decoder) Interpretation() build.Interpretation

Interpretation returns the current interpretation detected by Detect.

func (*Decoder) Next

func (i *Decoder) Next()

type Encoder

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

An Encoder converts CUE to various file formats, including CUE itself. An Encoder allows

func NewEncoder

func NewEncoder(f *build.File, cfg *Config) (*Encoder, error)

NewEncoder writes content to the file with the given specification.

func (Encoder) Close

func (e Encoder) Close() error

func (*Encoder) Encode

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

func (*Encoder) EncodeFile

func (e *Encoder) EncodeFile(f *ast.File) error

func (*Encoder) EncodeInstance

func (e *Encoder) EncodeInstance(v *cue.Instance) error

EncodeInstance is as Encode, but stores instance information. This should all be retrievable from the value itself.

func (*Encoder) IsConcrete

func (e *Encoder) IsConcrete() bool

IsConcrete reports whether the output is required to be concrete.

INTERNAL ONLY: this is just to work around a problem related to issue #553 of catching errors ony after syntax generation, dropping line number information.