Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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 // will potentially write more than one document per file
AllErrors bool
Schema cue.Value // used for schema-based decoding
EscapeHTML bool
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) 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) Interpretation ¶ added in v0.2.0
func (i *Decoder) Interpretation() build.Interpretation
Interpretation returns the current interpretation detected by Detect.
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) EncodeFile ¶
func (e *Encoder) EncodeFile(f *ast.File) error
func (*Encoder) EncodeInstance ¶ added in v0.3.0
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 ¶ added in v0.3.0
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.
Source Files
Directories