ui

package
v0.31.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2021 License: AGPL-3.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	StdColor   = color.New()            // Default color.
	ErrorColor = color.New(color.FgRed) // Errors.

	SuccColor     = color.New(color.FgGreen)             // Successful stuff.
	FailColor     = color.New(color.FgRed)               // Failed stuff.
	GrayColor     = color.New(color.Faint)               // Padding and disabled stuff.
	ValueColor    = color.New(color.FgCyan)              // Values of all kinds.
	ExtraColor    = color.New(color.FgCyan, color.Faint) // Extra annotations for values.
	ExtraKeyColor = color.New(color.Faint)               // Keys inside extra annotations.

	TypeColor    = color.New(color.FgYellow) // Syntax: Types.
	CommentColor = color.New(color.FgBlue)   // Syntax: Comments.
)

Functions

func Dump added in v0.18.0

func Dump(w io.Writer, v interface{})

func StrWidth added in v0.18.0

func StrWidth(s string) (n int)

StrWidth returns the actual width of the string.

Types

type Field added in v0.16.0

type Field interface {
	GetKey() string                        // Key for the data map.
	GetLabel() string                      // Label to print as the prompt.
	GetLabelExtra() string                 // Extra info for the label, eg. defaults.
	GetContents(io.Reader) (string, error) // Read the field contents from the supplied reader

	// Sanitize user input and return the field's native type.
	Clean(s string) (interface{}, error)
}

A Field in a form.

type Form added in v0.16.0

type Form struct {
	Banner string
	Fields []Field
}

A Form used to handle user interactions.

func (Form) Run added in v0.16.0

func (f Form) Run(r io.Reader, w io.Writer) (map[string]interface{}, error)

Run executes the form against the specified input and output.

type PasswordField added in v0.23.0

type PasswordField struct {
	Key   string
	Label string
	Min   int
}

PasswordField masks password input

func (PasswordField) Clean added in v0.23.0

func (f PasswordField) Clean(s string) (interface{}, error)

Clean just checks if the minimum length is exceeded, it doesn't trim the string!

func (PasswordField) GetContents added in v0.23.0

func (f PasswordField) GetContents(r io.Reader) (string, error)

GetContents simply reads a string in cleartext from the supplied reader

func (PasswordField) GetKey added in v0.23.0

func (f PasswordField) GetKey() string

GetKey returns the field's key

func (PasswordField) GetLabel added in v0.23.0

func (f PasswordField) GetLabel() string

GetLabel returns the field's label

func (PasswordField) GetLabelExtra added in v0.23.0

func (f PasswordField) GetLabelExtra() string

GetLabelExtra doesn't return anything so we don't expose the current password

type StringField added in v0.16.0

type StringField struct {
	Key     string
	Label   string
	Default string

	// Length constraints.
	Min, Max int
}

StringField is just a simple field for reading cleartext strings

func (StringField) Clean added in v0.16.0

func (f StringField) Clean(s string) (interface{}, error)

Clean trims the spaces in the string and checks for min and max length

func (StringField) GetContents added in v0.23.0

func (f StringField) GetContents(r io.Reader) (string, error)

GetContents simply reads a string in cleartext from the supplied reader It's compllicated and doesn't use t he bufio utils because we can't read ahead of the newline and consume more of the stdin, because we'll mess up the next form field

func (StringField) GetKey added in v0.16.0

func (f StringField) GetKey() string

GetKey returns the field's key

func (StringField) GetLabel added in v0.16.0

func (f StringField) GetLabel() string

GetLabel returns the field's label

func (StringField) GetLabelExtra added in v0.16.0

func (f StringField) GetLabelExtra() string

GetLabelExtra returns the field's default value

type Summary added in v0.26.0

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

Summary handles test summary output

func NewSummary added in v0.26.0

func NewSummary(cols []string) *Summary

NewSummary returns a new Summary instance, used for writing a summary/report of the test metrics data.

func (*Summary) SummarizeMetrics added in v0.26.0

func (s *Summary) SummarizeMetrics(w io.Writer, indent string, data SummaryData)

SummarizeMetrics creates a summary of provided metrics and writes it to w.

type SummaryData added in v0.18.0

type SummaryData struct {
	Metrics   map[string]*stats.Metric
	RootGroup *lib.Group
	Time      time.Duration
	TimeUnit  string
}

SummaryData represents data passed to Summary.SummarizeMetrics

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL