package export

import "cuelang.org/go/internal/core/export"

Index ¶

• Variables
• func Def(r adt.Runtime, pkgID string, v *adt.Vertex) (*ast.File, errors.Error)
• func Expr(r adt.Runtime, pkgID string, n adt.Expr) (ast.Expr, errors.Error)
• func ExtractDeclAttrs(a []adt.Conjunct) (attrs []*ast.Attribute)
• func ExtractDoc(v *adt.Vertex) (docs []*ast.CommentGroup)
• func ExtractFieldAttrs(a []adt.Conjunct) (attrs []*ast.Attribute)
• func Value(r adt.Runtime, pkgID string, n adt.Value) (ast.Expr, errors.Error)
• func Vertex(r adt.Runtime, pkgID string, n *adt.Vertex) (*ast.File, errors.Error)
• func VertexFeatures(v *adt.Vertex) []adt.Feature
• type Profile
• func (p *Profile) Def(r adt.Runtime, pkgID string, v *adt.Vertex) (*ast.File, errors.Error)
• func (p *Profile) Expr(r adt.Runtime, pkgID string, n adt.Expr) (ast.Expr, errors.Error)
• func (p *Profile) Value(r adt.Runtime, pkgID string, n adt.Value) (ast.Expr, errors.Error)
• func (p *Profile) Vertex(r adt.Runtime, pkgID string, n *adt.Vertex) (*ast.File, errors.Error)

Variables ¶

var All = &Profile{
	Simplify:        true,
	ShowOptional:    true,
	ShowDefinitions: true,
	ShowHidden:      true,
	ShowDocs:        true,
	ShowAttributes:  true,
}

var Final = &Profile{
	Simplify:     true,
	TakeDefaults: true,
}

var Raw = &Profile{
	ShowOptional:    true,
	ShowDefinitions: true,
	ShowHidden:      true,
	ShowDocs:        true,
}

var Simplified = &Profile{
	Simplify: true,
	ShowDocs: true,
}

Functions ¶

func Def ¶

func Def(r adt.Runtime, pkgID string, v *adt.Vertex) (*ast.File, errors.Error)

Def exports v as a definition.

func Expr ¶

func Expr(r adt.Runtime, pkgID string, n adt.Expr) (ast.Expr, errors.Error)

func ExtractDeclAttrs ¶

func ExtractDeclAttrs(a []adt.Conjunct) (attrs []*ast.Attribute)

func ExtractDoc ¶

func ExtractDoc(v *adt.Vertex) (docs []*ast.CommentGroup)

ExtractDoc collects documentation strings for a field.

Comments are attached to a field with a field shorthand belong to the child node. So in the following the comment is attached to field bar.

// comment
foo: bar: 2

func ExtractFieldAttrs ¶

func ExtractFieldAttrs(a []adt.Conjunct) (attrs []*ast.Attribute)

func Value ¶

func Value(r adt.Runtime, pkgID string, n adt.Value) (ast.Expr, errors.Error)

func Vertex ¶

func Vertex(r adt.Runtime, pkgID string, n *adt.Vertex) (*ast.File, errors.Error)

func VertexFeatures ¶

func VertexFeatures(v *adt.Vertex) []adt.Feature

VertexFeatures returns the feature list of v. The list may include more features than for which there are arcs and also includes features for optional fields. It assumes the Structs fields is properly initialized.

Types ¶

type Profile ¶

type Profile struct {
	Simplify bool

	// TakeDefaults is used in Value mode to drop non-default values.
	TakeDefaults bool

	// TODO:
	// IncludeDocs
	ShowOptional    bool
	ShowDefinitions bool

	// ShowHidden forces the inclusion of hidden fields when these would
	// otherwise be omitted. Only hidden fields from the current package are
	// included.
	ShowHidden     bool
	ShowDocs       bool
	ShowAttributes bool

	// ShowErrors treats errors as values and will not percolate errors up.
	ShowErrors bool
}

func (*Profile) Def ¶

func (p *Profile) Def(r adt.Runtime, pkgID string, v *adt.Vertex) (*ast.File, errors.Error)

Def exports v as a definition.

func (*Profile) Expr ¶

func (p *Profile) Expr(r adt.Runtime, pkgID string, n adt.Expr) (ast.Expr, errors.Error)

func (*Profile) Value ¶

func (p *Profile) Value(r adt.Runtime, pkgID string, n adt.Value) (ast.Expr, errors.Error)

Should take context.

func (*Profile) Vertex ¶

func (p *Profile) Vertex(r adt.Runtime, pkgID string, n *adt.Vertex) (*ast.File, errors.Error)

Source Files ¶

adt.go bounds.go export.go expr.go extract.go label.go toposort.go value.go