presentation

Documentation

Overview

Package presentation prints results of an expression evaluation in json and tabular formats.

Index

• func Bindings(w io.Writer, r Output) error
• func JSON(w io.Writer, x interface{}) error
• func Pretty(w io.Writer, r Output) error
• func Values(w io.Writer, r Output) error
• type DepAnalysisOutput
  • func (o DepAnalysisOutput) JSON(w io.Writer) error
  • func (o DepAnalysisOutput) Pretty(w io.Writer) error
• type Output
  • func (e Output) WithLimit(n int) Output

Functions

func Bindings

func Bindings(w io.Writer, r Output) error

Bindings prints the bindings from r to w.

func JSON

func JSON(w io.Writer, x interface{}) error

JSON writes x to w with indentation.

func Pretty

func Pretty(w io.Writer, r Output) error

Pretty prints all of r to w in a human-readable format.

func Values

func Values(w io.Writer, r Output) error

Values prints the values from r to w.

Types

type DepAnalysisOutput

type DepAnalysisOutput struct {
	Base    []ast.Ref `json:"base,omitempty"`
	Virtual []ast.Ref `json:"virtual,omitempty"`
}

DepAnalysisOutput contains the result of dependency analysis to be presented.

func (DepAnalysisOutput) JSON

func (o DepAnalysisOutput) JSON(w io.Writer) error

JSON outputs o to w as JSON.

func (DepAnalysisOutput) Pretty

func (o DepAnalysisOutput) Pretty(w io.Writer) error

Pretty outputs o to w in a human-readable format.

type Output

type Output struct {
	Error       error                `json:"error,omitempty"`
	Result      rego.ResultSet       `json:"result,omitempty"`
	Partial     *rego.PartialQueries `json:"partial,omitempty"`
	Metrics     metrics.Metrics      `json:"metrics,omitempty"`
	Explanation []*topdown.Event     `json:"explanation,omitempty"`
	Profile     []profiler.ExprStats `json:"profile,omitempty"`
	// contains filtered or unexported fields
}

Output contains the result of evaluation to be presented.

func (Output) WithLimit

func (e Output) WithLimit(n int) Output

WithLimit sets the output limit to set on stringified values.